-
-
Notifications
You must be signed in to change notification settings - Fork 464
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
Add support for global, non venv Python invocations #336
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Shims | ||
|
||
After installation Rye places two shims on your `PATH`: `python` and `python3`. These | ||
shims have specific behavior that changes depending on if they are used within a Rye | ||
managed project or outside. | ||
|
||
Inside a Rye managed project the resolve to the Python interpreter of the virtualenv. | ||
This means that even if you do not enable the virtualenv, you can just run `python` | ||
in a shell, and it will automatically operate in the right environment. | ||
|
||
Outside a Rye managed project it typically resolves to your system Python, though you | ||
can also opt to have it resolve to a Rye managed Python installation for you. This is | ||
done so that it's not disruptive to your existing workflows which might depend on the | ||
System python installation. | ||
|
||
## Global Shims | ||
|
||
+++ 0.9.0 | ||
|
||
To enable global shims, you need to enable the `global-python` flag in | ||
the [`config.toml`](config.md) file: | ||
|
||
```toml | ||
[behavior] | ||
global-python = true | ||
``` | ||
|
||
Afterwards if you run `python` outside of a Rye managed project it will | ||
spawn a Python interpreter that is shipped with Rye. It will honor the | ||
closest `.python-version` file for you. Additionally you can also | ||
explicitly request a specific Python version by adding `+VERSION` after | ||
the `python` command. For instance this runs a script with Python 3.8: | ||
|
||
```bash | ||
python +3.8 my-script.py | ||
``` | ||
|
||
!!! Note | ||
|
||
Selecting a specific Python version this way only works outside of | ||
Rye managed projects. Within Rye managed projects, the version needs | ||
to be explicitly selected via `.python-version` or with the | ||
`requires-python` key in `pyproject.toml`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This comment was marked as outdated.
Sorry, something went wrong.