Skip to content
This repository was archived by the owner on Oct 23, 2025. It is now read-only.

Commit dac8f95

Browse files
authored
update readme with env manager support (#753)
1 parent 4fc49ef commit dac8f95

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,26 @@ 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

@@ -57,6 +74,16 @@ The extension uses `pip` as the default package manager, but you can use the pac
5774
| ms-python.python:pip | `pip` | Pip acts as the default package manager and it's typically built-in to Python. |
5875
| ms-python.python:conda | `conda` | The [conda](https://conda.org) package manager, as provided by conda distributions like [Anaconda Distribution](https://docs.anaconda.com/anaconda/) or [conda-forge](https://conda-forge.org/download/). |
5976

77+
#### Default Package Manager by Environment Manager
78+
79+
| Environment Manager | Default Package Manager |
80+
|---------------------|------------------------|
81+
| venv | pip |
82+
| conda | conda |
83+
| pyenv | pip |
84+
| poetry | poetry |
85+
| system | pip |
86+
6087
### Project Management
6188

6289
A "Python Project" is any file or folder that contains runnable Python code and needs its own environment. With the Python Environments extension, you can add files and folders as projects in your workspace and assign individual environments to them allowing you to run various projects more seamlessly.

0 commit comments

Comments
 (0)