Skip to content

Python Version Issue in README.md (3.6+ Recommended but Only 3.8 to 3.11 Works) #1557

Open
@kanakOS01

Description

@kanakOS01

I encountered an issue when following the installation instructions for the codebase, which recommend Python 3.6+ as the required version (i was using 3.12 the default python version for ubuntu 24.04).

It worked when I used Python3.10. So I made a script to run the Pip and make/pip commands.

The Pip commands worked for Python version 3.9, 3.10.
The make/pip commands worked for Python version 3.8, 3.9, 3.10, 3.11.

Here is the script I ran for reference -
test-script-pip.sh

#!/bin/bash
VERSIONS=("3.6" "3.7" "3.8" "3.9" "3.10" "3.11" "3.12" "3.13")
cd zulip-terminal
for VER in  "${VERSIONS[@]}"; do
	echo "Testing with Python $VER..."
	pyenv local $VER
	python3 -m venv zt_venv
	source zt_venv/bin/activate
	LOG="../test_pip_log_${VER}.txt"
	{
		echo "Testing with Python $VER.."
		pip install -e '.[dev]'
	} &> "$LOG"
	deactivate
	rm -rf zt_venv
done
cd ..

test-script-make.sh

#!/bin/bash
VERSIONS=("3.6" "3.7" "3.8" "3.9" "3.10" "3.11" "3.12" "3.13")
cd zulip-terminal
for VER in  "${VERSIONS[@]}"; do
	echo "Testing with Python $VER..."
	pyenv local $VER
	LOG="../test_make_log_${VER}.txt"
	{
		echo "Testing with Python $VER.."
		make
		source zt_venv/bin/activate
	} &> "$LOG"
	deactivate
	rm -rf zt_venv
done
cd ..

Proposed Change:

I recommend updating the documentation to explicitly mention which Python versions are supported or to clarify that Python 3.8 to 3.11 is required, as others may not work as expected.
This will help avoid confusion for users who are trying to follow the instructions.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions