Skip to content

docs: clarify supported Python versions in installation section#1628

Open
hiteshmahajan24 wants to merge 1 commit intozulip:mainfrom
hiteshmahajan24:patch-1
Open

docs: clarify supported Python versions in installation section#1628
hiteshmahajan24 wants to merge 1 commit intozulip:mainfrom
hiteshmahajan24:patch-1

Conversation

@hiteshmahajan24
Copy link
Copy Markdown

@hiteshmahajan24 hiteshmahajan24 commented Mar 19, 2026

This PR updates the installation documentation to clarify supported Python versions.

The README previously mentioned Python 3.6+, which is inaccurate. Based on testing, the project works reliably with Python 3.8–3.11, while newer versions (3.12+) may not work due to dependency compatibility issues.

This change improves clarity and helps avoid setup errors for new contributors.

Fixes #1594

What does this PR do, and why?

Outstanding aspect(s)

  • [ ]

External discussion & connections

  • Discussed in #zulip-terminal in topic
  • Fully fixes #
  • Partially fixes issue #
  • Builds upon previous unmerged work in PR #
  • Is a follow-up to work in PR #
  • Requires merge of PR #
  • Merge will enable work on #

How did you test this?

  • Manually - Behavioral changes
  • Manually - Visual changes
  • Adapting existing automated tests
  • Adding automated tests for new behavior (or missing tests)
  • Existing automated tests should already cover this (only a refactor of tested code)

Self-review checklist for each commit

  • It is a minimal coherent idea
  • It has a commit summary following the documented style (title & body)
  • It has a commit summary describing the motivation and reasoning for the change
  • It individually passes linting and tests
  • It contains test additions for any new behavior
  • It flows clearly from a previous branch commit, and/or prepares for the next commit

Visual changes

This PR updates the installation documentation to clarify supported Python versions.

The README previously mentioned Python 3.6+, which is inaccurate. Based on testing, the project works reliably with Python 3.8–3.11, while newer versions (3.12+) may not work due to dependency compatibility issues.

This change improves clarity and helps avoid setup errors for new contributors.

Fixes zulip#1594
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: XS [Automatic label added by zulipbot]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants