Skip to content
Merged
Changes from all 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
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,48 @@

<!-- Plugin description -->

**PyVenvManage** is a plugin for managing the Python interpreter of Pycharm Projects.
**PyVenvManage** simplifies Python virtual environment management in JetBrains IDEs.

It is a general issue that Python projects may have several interpreters in different virtual environments for the
various versions of the language. Managing these venvs is easily done with `tox`, but configuring the project in Pycharm
is painful.

With PyVenvManage the selection and setup of the venv is a few clicks without dialog boxes.
Managing multiple Python interpreters across different virtual environments (for testing against various Python versions
with tools like `tox` or `nox`) traditionally requires navigating through multiple dialogs in PyCharm. PyVenvManage
streamlines this by enabling quick interpreter selection directly from the project view with just a right-click.

## Features

- Popup menu item to set the project interpreter
- Icon provider to indicate virtual environments in the project view
- **Quick interpreter switching**: Right-click any virtual environment folder to set it as your project or module
interpreter instantly
- **Visual identification**: Virtual environment folders display with a distinctive icon and Python version badge
(e.g., `venv [3.11.5]`) in the project view
- **Multi-IDE support**: Works with PyCharm (Community and Professional), IntelliJ IDEA, GoLand, CLion, and RustRover
- **Smart detection**: Automatically detects Python virtual environments by recognizing `pyvenv.cfg` files
- **Cached version display**: Python version information is cached for performance and automatically refreshed when
`pyvenv.cfg` files change

<!-- Plugin description end -->

## Install from the Official PyCharm repository
## Supported IDEs

- PyCharm (Community and Professional)
- IntelliJ IDEA (Community and Ultimate)
- GoLand
- CLion
- RustRover

In PyCharm open Settings -> Plugins, and install PyVenv Manage.
## Install

In your JetBrains IDE, open **Settings** -> **Plugins**, search for "PyVenv Manage", and click **Install**.

The official plugin page is at https://plugins.jetbrains.com/plugin/20536-pyvenv-manage-2

## Usage

![usage video](anim.gif?raw=true)

1. Create or navigate to a Python virtual environment folder in your project
2. Right-click the virtual environment folder (e.g., `venv`, `.venv`, or any folder with a `pyvenv.cfg`)
3. Select **Set as Project Interpreter** or **Set as Module Interpreter**
4. The interpreter is configured instantly with a confirmation notification

## License

This project is licensed under the BSD-3-Clause license - see the
Expand Down