-
Notifications
You must be signed in to change notification settings - Fork 533
docs: Provide guidance on using direnv
#3513
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
Merged
Merged
Changes from 12 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
09bdb21
added references to using direnv to activate pixi project environment…
phreed b85cabf
improved the wording
phreed ae5e3b3
improved the wording
phreed 7d5344e
Merge branch 'main' of github.com:phreed/pixi
phreed 50d2f27
Merge branch 'main' into main
Hofer-Julian 1439484
respond to comments
phreed d58f2ef
Merge branch 'main' of github.com:phreed/pixi
phreed 418dda9
Merge remote-tracking branch 'upstream'
phreed e6a2fa4
update mkdocs.yml with added editors
phreed 7cb820d
corrected links in mkdocs.yml
phreed dfcfbb6
added editors to nav in mkdocs.yml
phreed 6cc3119
the pre-commit does not like whitespace at line endings
phreed 53502af
vscode using the python extension
phreed 0e8f28b
fixed grammatical error
phreed c8998e5
Clarify docs
Hofer-Julian 5e5eadf
Adapt anchor
Hofer-Julian f2a8062
Merge branch 'main' into main
Hofer-Julian 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 hidden or 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,17 @@ | ||
| [Jetbrains](https://www.jetbrains.com/ides/) has a suite of popular develop environments. | ||
|
|
||
| To use `pixi` inside of a Jetbrains IDE, follow these steps: | ||
|
|
||
| * Create a `pixi.toml` file. | ||
|
|
||
| See [`direnv`](../third_party/direnv.md). | ||
| * Install `direnv`. | ||
| * Add an `.envrc` to the project. | ||
|
|
||
| Use [`direnv`](../third_party/direnv.md) via a | ||
| * Install the [Jetbrains `direnv` plugin](https://plugins.jetbrains.com/plugin/15285-direnv-integration) | ||
| which can be used to activate `pixi`. | ||
|
|
||
| Note: PyCharm belongs to the Jetbrains stable of IDE. | ||
| Unless you are doing polyglot projects it is recommended that the `pixi shell` approach, | ||
| [recommended here](pycharm.md) be used. |
This file contains hidden or 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,12 @@ | ||
| [Neovim](https://neovim.io/) is a popular develop environment. | ||
|
|
||
| To use `pixi` with Neovim, follow these steps: | ||
|
|
||
| * Create a `pixi.toml` file. | ||
|
|
||
| See [`direnv`](../third_party/direnv.md). | ||
| * Install `direnv`. | ||
| * Add an `.envrc` to the project. | ||
|
|
||
| Use a [Neovim Direnv](https://github.com/direnv/direnv.vim). | ||
| * Install the `direnv` plugin. |
This file contains hidden or 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,12 @@ | ||
| [VSCode](https://code.visualstudio.com/) is a popular develop environment. | ||
|
|
||
| To use `pixi` inside of VSCode, follow these steps: | ||
|
|
||
| * Create a `pixi.toml` file. | ||
|
|
||
| See [`direnv`](../third_party/direnv.md). | ||
| * Install `direnv`. | ||
| * Add an `.envrc` to the project. | ||
|
|
||
| Use a [VSCode extension](https://marketplace.visualstudio.com/items?itemName=mkhl.direnv). | ||
| * Install the `direnv` vscode extension |
This file contains hidden or 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,11 @@ | ||
| [Zed](https://zed.dev/) is a relatively new develop environment. | ||
|
Hofer-Julian marked this conversation as resolved.
Outdated
|
||
|
|
||
| To use `pixi` inside of Zed, follow these steps: | ||
|
|
||
| * Create a `pixi.toml` file. | ||
|
|
||
| See [`direnv`](../third_party/direnv.md). | ||
| * Install `direnv`. | ||
| * Add an `.envrc` to the project. | ||
|
|
||
| [Zed has native support for direnv](https://zed.dev/docs/configuring-zed#direnv-integration). | ||
This file contains hidden or 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 hidden or 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.
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.
The Python extension also has proper pixi support, we should mention that IMO
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.
You mean this https://code.visualstudio.com/docs/python/python-quick-start extension, correct?
I do not see an explicit mention of
pixi.I suppose it is something similar to
conda?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.
yes it's this extension. maybe add an image guide on how to do it?
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.
Yeah, If we have a proper vscode section, the Python extension should be mentioned as well 🙂
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.
I am not entirely sure how to use the python extension with
pixi.I saw that there is some effort to make a
pixi condabut I do not think that is the way to go.I am looking for a way to use
conda run ...as that should be translatable topixi run ....But, I am not finding that.
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.
I suppose trampolines could be used as the target of

but, trampolines are not provided as part of project workspaces.
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.
I suppose it comes down to the settings.yml for the python plugin:
https://code.visualstudio.com/docs/python/settings-reference
It is not obvious to me how this should be configured.
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.
It should no configuration.
I just created a fresh Pixi workspace with Python, started vscode in it and vscode immediately selected the pixi environment. Maybe @baszalmstra can check if something is broken on Windows at the moment?