From dd1959ff2464c5dd0a74fc7be2a57b37e284f1bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Fri, 2 Jan 2026 17:52:07 -0800 Subject: [PATCH] Improve plugin description and documentation - Rewrite introduction to be more concise and action-oriented - Expand feature list with detailed descriptions - Add supported IDEs section - Improve install instructions with step-by-step guidance - Add usage steps explaining the workflow --- README.md | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6e328ac..bd10376 100644 --- a/README.md +++ b/README.md @@ -9,23 +9,36 @@ -**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 + -## 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 @@ -33,6 +46,11 @@ The official plugin page is at https://plugins.jetbrains.com/plugin/20536-pyvenv ![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