Skip to content
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/integration/editor/jetbrains.md
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.
12 changes: 12 additions & 0 deletions docs/integration/editor/neovim.md
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.
12 changes: 12 additions & 0 deletions docs/integration/editor/vscode.md

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Contributor Author

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?

Copy link
Copy Markdown
Collaborator

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?

Copy link
Copy Markdown
Contributor

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 🙂

Copy link
Copy Markdown
Contributor Author

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 conda but 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 to pixi run ....
But, I am not finding that.

Copy link
Copy Markdown
Contributor Author

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
image
but, trampolines are not provided as part of project workspaces.

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor

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?

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
11 changes: 11 additions & 0 deletions docs/integration/editor/zed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[Zed](https://zed.dev/) is a relatively new develop environment.
Comment thread
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).
11 changes: 11 additions & 0 deletions docs/integration/third_party/direnv.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,14 @@ direnv: unloading
$ which python
python not found
```

While `direnv` comes with [hooks for the common shells](https://direnv.net/docs/hook.html),
these hooks into the shell should not be relied on when using and IDE.
Although `direnv` package does not include hooks for integrated develop environments,
there is typically a plugin or extension available.

Here you can see how to set up `direnv` for some of the more popular IDEs:
- [VSCode](../editor/vscode.md): [mkhl.direnv plugin](https://marketplace.visualstudio.com/items?itemName=mkhl.direnv)
- [Jetbrains](../editor/jetbrains.md): [Direnv Integration plugin](https://plugins.jetbrains.com/plugin/15285-direnv-integration)
- [Zed](../editor/zed.md): [Native support](https://zed.dev/docs/configuring-zed#direnv-integration)
- [Neovim](../editor/neovim.md): [Direnv plugin](https://github.com/direnv/direnv.vim/blob/master/README.md)
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,12 @@ nav:
- Editor:
- JupyterLab: integration/editor/jupyterlab.md
- PyCharm: integration/editor/pycharm.md
- Jetbrains: integration/editor/jetbrains.md
- RStudio: integration/editor/r_studio.md
- VSCode Devcontainer: integration/editor/devcontainer.md
- VSCode: integration/editor/vscode.md
- Zed: integration/editor/zed.md
- Neovim: integration/editor/neovim.md
- Continuous Integration:
- GitHub Actions: integration/ci/github_actions.md
- Lockfile Updates: integration/ci/updates_github_actions.md
Expand Down Expand Up @@ -200,8 +204,12 @@ plugins:
"features/pytorch.md": "python/pytorch.md"
"ide_integration/jupyterlab.md": "integration/editor/jupyterlab.md"
"ide_integration/pycharm.md": "integration/editor/pycharm.md"
"ide_integration/jetbrains.md": "integration/editor/jetbrains.md"
"ide_integration/r_studio.md": "integration/editor/r_studio.md"
"ide_integration/devcontainer.md": "integration/editor/devcontainer.md"
"ide_integration/vscode.md": "integration/editor/vscode.md"
"ide_integration/zed.md": "integration/editor/zed.md"
"ide_integration/neovim.md": "integration/editor/neovim.md"
"advanced/authentication.md": "deployment/authentication.md"
"advanced/channel_priority.md": "advanced/channel_logic.md"
"advanced/github_actions.md": "integration/ci/github_actions.md"
Expand Down