You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+50-20Lines changed: 50 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,11 @@ This extension provides an Environments view, which can be accessed via the VS C
14
14
15
15
By default, the extension uses the `venv` environment manager. This default manager determines how environments are created, managed, and where packages are installed. However, users can change the default by setting the `python-envs.defaultEnvManager` to a different environment manager. The following environment managers are supported out of the box:
16
16
17
-
|Id| name |Description|
18
-
|---|----|--|
19
-
|ms-python.python:venv|`venv`|The default environment manager. It is a built-in environment manager provided by the Python standard library.|
20
-
|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. |
21
-
|ms-python.python:conda|`conda`| The [Anaconda](https://www.anaconda.com/) environment manager. |
|ms-python.python:venv|`venv`|The default environment manager. It is a built-in environment manager provided by the Python standard library.|
20
+
|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. |
21
+
|ms-python.python:conda|`conda`| The [Anaconda](https://www.anaconda.com/) environment manager.|
22
22
23
23
The environment manager is responsible for specifying which package manager will be used by default to install and manage Python packages within the environment. This ensures that packages are managed consistently according to the preferred tools and settings of the chosen environment manager.
24
24
@@ -28,27 +28,58 @@ This extension provides a package view for you to manage, install and uninstall
28
28
29
29
The extension uses `pip` as the default package manager. You can change this by setting the `python-envs.defaultPackageManager` setting to a different package manager. The following are package managers supported out of the box:
30
30
31
-
|Id| name |Description|
32
-
|---|----|--|
33
-
|ms-python.python:pip|`pip`| Pip acts as the default package manager and it's typically built-in to Python.|
|ms-python.python:pip|`pip`| Pip acts as the default package manager and it's typically built-in to Python.|
34
+
|ms-python.python:conda|`conda`| The [Anaconda](https://www.anaconda.com/) environment manager.|
35
35
36
36
## Settings Reference
37
37
38
-
| Setting (python-envs.) |Default |Description |
39
-
| ----- | ----- | -----|
40
-
| defaultEnvManager |`"ms-python.python:venv"`|The default environment manager used for creating and managing environments. |
41
-
| defaultPackageManager |`"ms-python.python:pip"`|The default package manager to use for installing and managing packages. This is often dictated by the default environment manager but can be customized. |
42
-
| pythonProjects |`[]`|A list of Python workspaces, specified by the path, in which you can set particular environment and package managers. You can set information for a workspace as `[{"path": "/path/to/workspace", "envManager": "ms-python.python:venv", "packageManager": "ms-python.python:pip"]}`. |
| defaultEnvManager |`"ms-python.python:venv"`|The default environment manager used for creating and managing environments.|
41
+
| defaultPackageManager |`"ms-python.python:pip"`|The default package manager to use for installing and managing packages. This is often dictated by the default environment manager but can be customized.|
42
+
| pythonProjects |`[]`|A list of Python workspaces, specified by the path, in which you can set particular environment and package managers. You can set information for a workspace as `[{"path": "/path/to/workspace", "envManager": "ms-python.python:venv", "packageManager": "ms-python.python:pip"]}`. |
43
43
44
+
## API Reference (proposed)
44
45
45
-
## API Reference
46
+
See [api.ts](https://github.com/microsoft/vscode-python-environments/blob/main/src/api.ts) for the full list of Extension APIs.
## Questions, issues, feature requests, and contributions
65
95
66
96
- If you have a question about how to accomplish something with the extension, please [ask on our Discussions page](https://github.com/microsoft/vscode-python/discussions/categories/q-a).
@@ -77,7 +107,7 @@ The Microsoft Python Extension for Visual Studio Code collects usage data and se
77
107
78
108
## Trademarks
79
109
80
-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow
110
+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow
0 commit comments