Skip to content

docs: mention recommended Python version for local setup #1145

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.

Sign up for GitHub

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

Open
ankit-gupta-git wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: mention recommended Python version for local setup #1145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ PictoPy is an advanced desktop gallery application that combines the power of Ta
1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.

## Recommended Python Version

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.
Comment on lines +14 to +15
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 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 yaml

Repository: 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 -20

Repository: 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.


# Architecture

### Frontend
Expand Down