Skip to content

Commit 10d15b8

Browse files
committed
update readme for current environment manager support
1 parent d0afbd1 commit 10d15b8

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,31 @@ The following environment managers are supported out of the box:
4040

4141
| Id | Name | Description |
4242
| ----------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
43-
| ms-python.python:venv | `venv` | The default environment manager. It is a built-in environment manager provided by the Python standard library. |
44-
| ms-python.python:system | System Installed Python | These are global Python installs on your system. These are typically installed with your OS, from [python.org](https://www.python.org/), or any other OS package manager. |
45-
| ms-python.python:conda | `conda` | The [conda](https://conda.org) environment manager, as provided by conda distributions like [Anaconda Distribution](https://docs.anaconda.com/anaconda/) or [conda-forge](https://conda-forge.org/download/). |
43+
| ms-python.python:venv | `venv` | Built-in environment manager provided by the Python standard library. Supports creating environments (interactive and quick create) and finding existing environments. |
44+
| ms-python.python:system | System Installed Python | Global Python installs on your system, typically installed with your OS, from [python.org](https://www.python.org/), or any other OS package manager. |
45+
| ms-python.python:conda | `conda` | The [conda](https://conda.org) environment manager, as provided by conda distributions like [Anaconda Distribution](https://docs.anaconda.com/anaconda/) or [conda-forge](https://conda-forge.org/download/). Supports creating environments (interactive and quick create) and finding existing environments. |
46+
| ms-python.python:pyenv | `pyenv` | The [pyenv](https://github.com/pyenv/pyenv) environment manager, used to manage multiple Python versions. Supports finding existing environments. |
47+
| ms-python.python:poetry | `poetry` | The [poetry](https://python-poetry.org/) environment manager, used for dependency management and packaging in Python projects. Supports finding existing environments. |
48+
49+
#### Supported Actions by Environment Manager
50+
51+
| Environment Manager | Find Environments | Create | Quick Create |
52+
|---------------------|-------------------|--------|--------------|
53+
| venv ||||
54+
| conda ||||
55+
| pyenv || | |
56+
| poetry || | |
57+
| system || | |
58+
59+
**Legend:**
60+
- **Create**: Ability to create new environments interactively.
61+
- **Quick Create**: Ability to create environments with minimal user input.
62+
- **Find Environments**: Ability to discover and list existing environments.
4663

4764
Environment managers are responsible for specifying which package manager will be used by default to install and manage Python packages within the environment (`venv` uses `pip` by default). This ensures that packages are managed consistently according to the preferred tools and settings of the chosen environment manager.
4865

66+
67+
4968
### Package Management
5069

5170
The extension also provides an interface to install and uninstall Python packages, and provides APIs for extension developers to contribute package managers of their choice.

0 commit comments

Comments
 (0)