Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pavelzw/pixi-pycharm

Conda shim for PyCharm that proxies pixi
https://github.com/pavelzw/pixi-pycharm

conda pixi pycharm

Last synced: 2 months ago
JSON representation

Conda shim for PyCharm that proxies pixi

Host: GitHub
URL: https://github.com/pavelzw/pixi-pycharm
Owner: pavelzw
License: bsd-3-clause
Created: 2024-03-12T00:30:50.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-08-31T13:26:10.000Z (4 months ago)
Last Synced: 2024-09-27T06:02:18.462Z (3 months ago)
Topics: conda, pixi, pycharm
Language: Python
Homepage: https://pixi.sh/dev/ide_integration/pycharm
Size: 2.54 MB
Stars: 17
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


[![License][license-badge]][license]

[![CI][ci-badge]][ci]

[![Latest release][latest-release-badge]][releases]

[![conda-forge](https://img.shields.io/conda/pn/conda-forge/pixi-pycharm?logoColor=white&logo=conda-forge&style=flat-square)](https://prefix.dev/channels/conda-forge/packages/pixi-pycharm)

[![Project Chat][chat-badge]][chat-url]

[![Pixi Badge][pixi-badge]][pixi]

[license-badge]: https://img.shields.io/github/license/pavelzw/pixi-pycharm?style=flat-square

[license]: ./LICENSE

[ci-badge]: https://img.shields.io/github/actions/workflow/status/pavelzw/pixi-pycharm/ci.yml?style=flat-square

[ci]: https://github.com/pavelzw/pixi-pycharm/actions/

[latest-release-badge]: https://img.shields.io/github/v/tag/pavelzw/pixi-pycharm?style=flat-square&label=latest&sort=semver

[releases]: https://github.com/pavelzw/pixi-pycharm/releases

[chat-badge]: https://img.shields.io/discord/1082332781146800168.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square

[chat-url]: https://discord.gg/kKV8ZxyzY4

[pixi-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square

[pixi]: https://pixi.sh



# pixi-pycharm

Add [pixi](https://github.com/prefix-dev/pixi) support to PyCharm.

## How to use

To get started, add `pixi-pycharm` to your pixi project.

```bash

pixi add pixi-pycharm

```

This will ensure that the conda shim is installed in your project's environment.

Having `pixi-pycharm` installed, you can now configure PyCharm to use your pixi environments.

Go to the _Add Python Interpreter_ dialog (bottom right corner of the PyCharm window) and select _Conda Environment_.

Set _Conda Executable_ to the full path of the `conda` file (on Windows: `conda.bat`) which is located in `.pixi/envs/default/libexec`.

You can get the path using the following command:

```bash

# on Linux/macOS

pixi run 'echo $CONDA_PREFIX/libexec/conda'

# on Windows

pixi run 'echo $CONDA_PREFIX\\libexec\\conda.bat'

```

This is an executable that tricks PyCharm into thinking it's the proper `conda` executable.

Under the hood it redirects all calls to the corresponding `pixi` equivalent.

> [!WARNING]

> Please make sure that this is the `conda` shim from this pixi project and not another one.

> If you use multiple pixi projects, you might have to adjust the path accordingly as PyCharm remembers the path to the conda executable.

![Add Python Interpreter](./.github/assets/add-conda-environment-light.png#gh-light-mode-only)

![Add Python Interpreter](./.github/assets/add-conda-environment-dark.png#gh-dark-mode-only)

Having selected the environment, PyCharm will now use the Python interpreter from your pixi environment.

PyCharm should now be able to show you the installed packages as well.

![PyCharm package list](./.github/assets/dependency-list-light.png#gh-light-mode-only)

![PyCharm package list](./.github/assets/dependency-list-dark.png#gh-dark-mode-only)

You can now run your programs and tests as usual.

![PyCharm run tests](./.github/assets/tests-light.png#gh-light-mode-only)

![PyCharm run tests](./.github/assets/tests-dark.png#gh-dark-mode-only)

> [!TIP]

> In order for PyCharm to not get confused about the `.pixi` directory, please mark it as excluded.

>

> ![Mark Directory as excluded 1](./.github/assets/mark-directory-as-excluded-1-light.png#gh-light-mode-only)

> ![Mark Directory as excluded 1](./.github/assets/mark-directory-as-excluded-1-dark.png#gh-dark-mode-only)

> ![Mark Directory as excluded 2](./.github/assets/mark-directory-as-excluded-2-light.png#gh-light-mode-only)

> ![Mark Directory as excluded 2](./.github/assets/mark-directory-as-excluded-2-dark.png#gh-dark-mode-only)

>

> Also, when using a remote interpreter, you should exclude the `.pixi` directory on the remote machine.

> Instead, you should run `pixi install` on the remote machine and select the conda shim from there.

> ![Deployment exclude from remote machine](./.github/assets/deployment-exclude-pixi-light.png#gh-light-mode-only)

> ![Deployment exclude from remote machine](./.github/assets/deployment-exclude-pixi-dark.png#gh-dark-mode-only)

### Multiple environments

If your project uses [multiple environments](https://pixi.sh/latest/environment) to tests different Python versions or dependencies, you can add multiple environments to PyCharm

by specifying _Use existing environment_ in the _Add Python Interpreter_ dialog.

![Multiple pixi environments](./.github/assets/python-interpreters-multi-env-light.png#gh-light-mode-only)

![Multiple pixi environments](./.github/assets/python-interpreters-multi-env-dark.png#gh-dark-mode-only)

You can then specify the corresponding environment in the bottom right corner of the PyCharm window.

![Specify environment](./.github/assets/specify-interpreter-light.png#gh-light-mode-only)

![Specify environment](./.github/assets/specify-interpreter-dark.png#gh-dark-mode-only)

### Multiple pixi projects

When using multiple pixi projects, remember to select the correct _Conda Executable_ for each project as mentioned above.

It also might come up that you have multiple environments it might come up that you have multiple environments with the same name.

![Multiple default environments](./.github/assets/multiple-default-envs-light.png#gh-light-mode-only)

![Multiple default environments](./.github/assets/multiple-default-envs-dark.png#gh-dark-mode-only)

It is recommended to rename the environments to something unique.

## Debugging

Logs are written to `~/.cache/pixi-pycharm.log`.

You can use them to debug problems.

Please attach the logs when [filing a bug report](https://github.com/pavelzw/pixi-pycharm/issues/new?template=bug-report.md).