Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Sep 4, 2025

Summary by CodeRabbit

  • Documentation
    • Added a new section on creating and using a virtual environment with RustPython, including activation and using python as an alias.
    • Added guidance for enabling SSL support and setting up pip, with Windows-specific notes and considerations for OpenSSL 3.
    • Documented steps to install pip via the SSL-enabled build and subsequent installation command.
    • Provided an alternative setup path using conda.
    • No functional changes to the application or APIs.

@youknowone youknowone added the skip:ci Skip running the ci label Sep 4, 2025
Copy link
Contributor

coderabbitai bot commented Sep 4, 2025

Walkthrough

Documentation 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

Cohort / File(s) Summary
Docs: venv and pip guidance
README.md
Added sections detailing RustPython venv setup/activation and HTTPS/SSL enablement for pip installation, including Windows OpenSSL guidance, cargo install with ssl feature, rustpython --install-pip steps, and conda-based alternatives.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I thump my paws, the docs now gleam,
With venv spells and pip’s bright stream.
SSL unlocked, a secure new hop,
Cargo builds, then pip goes pop.
From Windows burrow to conda warren—
My README trail is well-forewarnin’. 🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch readme

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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: 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
+### pip

Additional 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 0c8ae3a and 3338aed.

📒 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.

Copy link
Collaborator

@ShaharNaveh ShaharNaveh left a 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
Copy link
Collaborator

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip:ci Skip running the ci
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants