Skip to content

Conversation

@Darshita02
Copy link

@Darshita02 Darshita02 commented Dec 30, 2025

This PR updates the README.md to include clear instructions for setting up the Python backend for PictoPy.

Changes include:

  • Added step-by-step instructions for creating and activating a virtual environment.
  • Added instructions for installing backend dependencies.
  • Added instructions for running the backend server.
  • Fixed all code blocks with proper opening and closing triple backticks to ensure correct formatting and syntax highlighting.

This should help new contributors get the backend running smoothly and reduce setup confusion.

Summary by CodeRabbit

  • Documentation
    • Added a Backend Setup (Python) guide to README covering required Python version (Python 3.11.x) and step-by-step instructions to create/activate a virtual environment, install backend dependencies, and run the backend for local testing.

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 30, 2025

📝 Walkthrough

Walkthrough

The pull request adds a "Backend Setup (Python)" section to README.md that specifies Python 3.11.x, shows how to create/activate a virtual environment (Windows Git Bash example), install dependencies from backend/requirements.txt, and run the backend with python backend/main.py.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "Backend Setup (Python)" section: requires Python 3.11.x (notes Python 3.13 unsupported), provides virtualenv creation/activation steps (Windows Git Bash example), dependency install via pip install -r backend/requirements.txt, and startup command python backend/main.py.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README so clear, a setup so neat,
Python three-eleven — steady and sweet,
Virtualenv snug, deps all in line,
Backend awakened, servers hum fine,
Hopping to code, with joy I define. ✨

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding Python backend setup instructions with proper code block formatting to README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 916c048 and a00e3bd.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

19-37: Add platform-specific instructions for macOS and Linux.

The setup instructions are currently limited to Windows (Git Bash). Since PictoPy is marketed as cross-platform, contributors on macOS and Linux will need equivalent instructions. Consider adding branches for each platform, or clarifying if setup differs across platforms.

🔎 Example structure for multi-platform instructions
### 1. Create and activate a virtual environment

**Windows (Git Bash):**
\`\`\`bash
python -m venv venv
source venv/Scripts/activate
\`\`\`

**macOS and Linux:**
\`\`\`bash
python3 -m venv venv
source venv/bin/activate
\`\`\`

This ensures users on all platforms have clear, actionable guidance.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4043751 and 916c048.

📒 Files selected for processing (1)
  • README.md
🔇 Additional comments (1)
README.md (1)

12-37: Backend setup documentation is a valuable addition.

The new "Backend Setup (Python)" section provides clear, step-by-step guidance with proper code block formatting and appropriate version constraints. This will help reduce setup friction for new contributors. Once the minor formatting issue and platform coverage are addressed, this section will be solid.

@Darshita02
Copy link
Author

Hi maintainers ,
I’ve added Python backend setup instructions to the README to help new contributors avoid setup issues (especially Python version compatibility).

Please let me know if any changes or improvements are needed.
Thanks for your time!

@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

1 similar comment
@github-actions
Copy link
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

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

Successfully merging this pull request may close these issues.

1 participant