-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Update README with venv and PIP instructions #6127
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughDocumentation updates to README.md adding sections on creating/using a Python virtual environment with RustPython and enabling SSL/pip installation, including Windows-specific notes and conda alternatives. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
71-71
: Tighten wording and cross-link to pip section.Reads a bit awkward; also helpful to point readers to the pip steps they’ll likely need right after creating a venv.
-Because RustPython currently doesn't provide a well-packaged installation, using venv helps to use pip easier. +Because RustPython currently doesn't provide OS-level installers, using a virtual environment (venv) makes it easier to manage packages with pip. See the [pip](#pip) section below to enable SSL and install pip.
73-77
: Fix markdownlint MD014 and add Windows activation variants.Remove
$
prompts (no output shown) and include Windows activation commands; also tweak the comment for clarity.-```sh -$ rustpython -m venv <your_env_name> -$ . <your_env_name>/bin/activate -$ python # now `python` is the alias of the RustPython for the new env -``` +```sh +rustpython -m venv <your_env_name> +# Linux/macOS +source <your_env_name>/bin/activate +# Windows PowerShell +.<your_env_name>\Scripts\Activate.ps1 +# Windows cmd.exe +.<your_env_name>\Scripts\activate.bat +python # "python" now resolves to RustPython inside this venv +```
79-79
: Use lowercase “pip” for consistency and add a Windows example for ssl-vendor.Everywhere else uses tool names in lowercase (“venv”, “pip”). Also, show the Windows-friendly install variant mentioned in the text.
-### PIP +### pipAdditional snippet to include under the existing cargo install example (no diff context needed):
# On Windows, alternatively: cargo install --git https://github.com/RustPython/RustPython --features ssl-vendor
Can you confirm the Windows PowerShell/cmd activation commands and the
ssl-vendor
example above on a fresh Windows environment?
📜 Review details
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
74-74: Dollar signs used before commands without showing output
(MD014, commands-show-output)
75-75: Dollar signs used before commands without showing output
(MD014, commands-show-output)
76-76: Dollar signs used before commands without showing output
(MD014, commands-show-output)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Check Rust code with rustfmt and clippy
🔇 Additional comments (1)
README.md (1)
69-69
: Section heading looks good.Clear and well-placed before the pip guidance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
```sh | ||
$ rustpython -m venv <your_env_name> | ||
$ . <your_env_name>/bin/activate | ||
$ python # now `python` is the alias of the RustPython for the new env |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it python or python3?
Summary by CodeRabbit