Skip to content

Commit 79d0da1

Browse files
committed
Initial changes
1 parent b275e8b commit 79d0da1

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Python Environments and Package Manager (experimental)
1+
# Python Environments (experimental)
22

33
## Overview
44

5-
The Python Environments and Package Manager extension for VS Code helps you manage Python environments and packages using your preferred environment manager backed by its extensible APIs. This extension provides unique support to specify environments for specific files or whole Python folders or projects, including multi-root & mono-repos scenarios.
5+
The Python Environments extension for VS Code helps you manage Python environments and packages using your preferred environment manager backed by its extensible APIs. This extension provides unique support to specify environments for specific files or whole Python folders or projects, including multi-root & mono-repos scenarios.
66

77
> Note: This extension is in preview and its APIs and features are subject to change as the project continues to evolve.
88
@@ -17,7 +17,11 @@ The Python Environments and Package Manager extension for VS Code helps you mana
1717

1818
This extension provides an Environments view, which can be accessed via the VS Code Activity Bar, where you can manage your Python environments. Here, you can create, delete, and switch between environments, as well as install and uninstall packages within the selected environment. It also provides APIs for extension developers to contribute their own environment managers.
1919

20-
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:
20+
ADD A QUICK REFERENCE FOR UI BUTTON
21+
22+
To further simplify the environment creation process, you can create a virtual environments using "Quick Create", which uses your default environment manager (i.e. `venv`) and the most updated Python version to create a virtual environment. If you would like more control over your environment features, such as the Python version used, the environment name, packages installed, etc. you can create a custom environment.
23+
24+
The following environment managers are supported out of the box:
2125

2226
| Id | name | Description |
2327
| ----------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -31,13 +35,24 @@ The environment manager is responsible for specifying which package manager will
3135

3236
This extension provides a package view for you to manage, install and uninstall you Python packages in any particular environment. This extension provides APIs for extension developers to contribute package managers.
3337

38+
ADD A QUICK REFERENCE FOR BUTTONS
39+
3440
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:
3541

36-
| Id | name | Description |
42+
| Id | Name | Description |
3743
| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3844
| ms-python.python:pip | `pip` | Pip acts as the default package manager and it's typically built-in to Python. |
3945
| 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/). |
4046

47+
## Command Reference
48+
49+
| Name | Description |
50+
| Python: Manage Packages | |
51+
| Python: Create Project | |
52+
| Python: Activate Environment in Current Terminal | |
53+
| Python: Deactivate Environment in Current Terminal | |
54+
| Python: Run as Task | |
55+
4156
## Settings Reference
4257

4358
| Setting (python-envs.) | Default | Description |
@@ -47,7 +62,11 @@ The extension uses `pip` as the default package manager. You can change this by
4762
| 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"]}`. |
4863
| terminal.showActivateButton | `false` | [experimental] Show a button in the terminal to activate/deactivate the current environment for the terminal. This button is only shown if the active terminal is associated with a project that has an activatable environment. |
4964

50-
## API Reference (proposed)
65+
## Extensibility
66+
67+
The Python Environments extension was built to provide a cohesive and user friendly experience with `venv` as the default. However, the extension is built with extensibility in mind so that any environment manager could build an extension using the supported APIs to plug-in and provide a seamless and incirporated experience for their users in VS Code.
68+
69+
### API Reference (proposed)
5170

5271
See [api.ts](https://github.com/microsoft/vscode-python-environments/blob/main/src/api.ts) for the full list of Extension APIs.
5372

0 commit comments

Comments
 (0)