Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kanakOS01 opened this issue Dec 6, 2024 · 0 comments

Comments

@kanakOS01
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant