docs: mention recommended Python version for local setup#1145
docs: mention recommended Python version for local setup#1145ankit-gupta-git wants to merge 1 commit intoAOSSIE-Org:mainfrom
Conversation
|
|
📝 WalkthroughWalkthroughA documentation update adding a "Recommended Python Version" section to the README, specifying Python 3.10 or 3.11 for local development and noting potential compatibility concerns with newer Python versions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Important Action Needed: IP Allowlist UpdateIf your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:
Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 14-15: Update the README.md's Python recommendation text that
currently says "Python 3.10 or 3.11" to recommend Python 3.12 so it matches the
project setup scripts (setup.sh, setup.ps1) and docs/Manual_Setup_Guide.md; also
ensure the README notes that CI tests currently include 3.11 and that 3.12
should be added to the CI test matrix if not already covered.
| For local development, it is recommended to use **Python 3.10 or 3.11**. | ||
| Some dependencies may not yet be fully compatible with newer Python versions. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Check Python version specifications in project configuration files
# Check for Python version requirements in common configuration files
echo "=== Checking pyproject.toml ==="
fd -t f '^pyproject\.toml$' --exec cat {}
echo -e "\n=== Checking setup.py ==="
fd -t f '^setup\.py$' --exec cat {}
echo -e "\n=== Checking requirements files ==="
fd -t f 'requirements.*\.txt$' --exec sh -c 'echo "File: {}" && cat {}'
echo -e "\n=== Checking for .python-version ==="
fd -t f '^\.python-version$' --exec cat {}
echo -e "\n=== Checking runtime.txt ==="
fd -t f '^runtime\.txt$' --exec cat {}Repository: AOSSIE-Org/PictoPy
Length of output: 2818
🏁 Script executed:
#!/bin/bash
# Check CI/CD configurations and Docker files for Python version specifications
echo "=== Checking GitHub Actions workflows ==="
fd -t f '\.github/workflows.*\.yml$|\.github/workflows.*\.yaml$' --exec sh -c 'echo "File: {}" && cat {}'
echo -e "\n=== Checking Dockerfile ==="
fd -t f 'Dockerfile*' --exec sh -c 'echo "File: {}" && cat {}'
echo -e "\n=== Checking tox.ini ==="
fd -t f 'tox\.ini$' --exec cat {}
echo -e "\n=== Checking .gitlab-ci.yml ==="
fd -t f '\.gitlab-ci\.yml$' --exec cat {}
echo -e "\n=== Checking pyproject.toml for python specification ==="
fd -t f 'pyproject\.toml$' --exec sh -c 'cat {} | grep -A 5 -B 5 -i "python\|requires"'Repository: AOSSIE-Org/PictoPy
Length of output: 249
🏁 Script executed:
#!/bin/bash
# Get an overview of the repository structure
echo "=== Repository structure ==="
git ls-files | head -30
echo -e "\n=== Searching for Python version mentions ==="
rg -i "python.*[0-9]\.[0-9]|version.*python" --max-count=20
echo -e "\n=== Checking README.md around lines 14-15 ==="
sed -n '10,20p' README.md
echo -e "\n=== Checking if pyproject.toml has python_requires ==="
cat pyproject.toml 2>/dev/null || echo "pyproject.toml not found or error reading"
echo -e "\n=== Searching all files for python-requires or Python version constraints ==="
rg "python_requires|python-requires|python >= |python <=" --type python --type toml --type yamlRepository: AOSSIE-Org/PictoPy
Length of output: 11914
🏁 Script executed:
#!/bin/bash
# Check Python version support for key dependencies
echo "=== Checking CI/CD workflows for Python versions ==="
cat .github/workflows/pr-check-tests.yml 2>/dev/null | grep -i "python\|version" || echo "File not found or no matches"
echo -e "\n=== Looking at backend requirements for version constraints ==="
head -20 backend/requirements.txt
echo -e "\n=== Checking setup scripts for Python version details ==="
head -30 scripts/setup.sh
echo -e "\n=== Checking docs for Python version info ==="
grep -r "Python\|python" docs/Manual_Setup_Guide.md | head -20Repository: AOSSIE-Org/PictoPy
Length of output: 1927
Update Python version recommendation to match project setup documentation and scripts.
The README recommends Python 3.10 or 3.11, but the project's setup scripts (setup.sh, setup.ps1) and documentation (docs/Manual_Setup_Guide.md) specify Python 3.12. Update the README to recommend Python 3.12 to align with the actual setup instructions. The CI/CD pipeline currently tests against Python 3.11, so consider also adding 3.12 to the test matrix if it isn't already covered.
🤖 Prompt for AI Agents
In `@README.md` around lines 14 - 15, Update the README.md's Python recommendation
text that currently says "Python 3.10 or 3.11" to recommend Python 3.12 so it
matches the project setup scripts (setup.sh, setup.ps1) and
docs/Manual_Setup_Guide.md; also ensure the README notes that CI tests currently
include 3.11 and that 3.12 should be added to the CI test matrix if not already
covered.
1 participant
While setting up PictoPy locally, I noticed some confusion around Python versions.
This came up in the AOSSIE Discord discussion as well.
This PR documents a recommended Python version in the README to help new contributors avoid setup issues.
Summary by CodeRabbit