Skip to content

Commit 70ddeba

Browse files
authored
Improve plugin description and documentation (#105)
1 parent e1df074 commit 70ddeba

1 file changed

Lines changed: 28 additions & 10 deletions

File tree

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,48 @@
99

1010
<!-- Plugin description -->
1111

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

14-
It is a general issue that Python projects may have several interpreters in different virtual environments for the
15-
various versions of the language. Managing these venvs is easily done with `tox`, but configuring the project in Pycharm
16-
is painful.
17-
18-
With PyVenvManage the selection and setup of the venv is a few clicks without dialog boxes.
14+
Managing multiple Python interpreters across different virtual environments (for testing against various Python versions
15+
with tools like `tox` or `nox`) traditionally requires navigating through multiple dialogs in PyCharm. PyVenvManage
16+
streamlines this by enabling quick interpreter selection directly from the project view with just a right-click.
1917

2018
## Features
2119

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

26-
## Install from the Official PyCharm repository
31+
## Supported IDEs
32+
33+
- PyCharm (Community and Professional)
34+
- IntelliJ IDEA (Community and Ultimate)
35+
- GoLand
36+
- CLion
37+
- RustRover
2738

28-
In PyCharm open Settings -> Plugins, and install PyVenv Manage.
39+
## Install
40+
41+
In your JetBrains IDE, open **Settings** -> **Plugins**, search for "PyVenv Manage", and click **Install**.
2942

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

3245
## Usage
3346

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

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

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

0 commit comments

Comments
 (0)