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
+10-21Lines changed: 10 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The Python Environments extension for VS Code helps you manage Python environmen
15
15
16
16
## Features
17
17
18
-
The "Python Projects" fold shows you all of the projects that are currently in your workspace and their selected environments. From this view you can add more files or folders as projects, select a new environment for your project, and manage your selected environments.
18
+
The "Python Projects" fold shows you all of the projects that are currently in your workspace and their selected environments. From this view you can add more files or folders as projects, select a new environment for your project, and manage your selected environments.
19
19
20
20
The "Environment Managers" fold shows you all of the environment managers that are available on your machine with all related environments nested below. From this view, you can create new environments, delete old environments, and manage packages.
21
21
@@ -25,7 +25,7 @@ The "Environment Managers" fold shows you all of the environment managers that a
25
25
26
26
The Python Environments panel provides an interface to create, delete and manage environments.
To simplify the environment creation process, you can use "Quick Create" to automatically create a new virtual environment using:
31
31
@@ -35,8 +35,6 @@ To simplify the environment creation process, you can use "Quick Create" to auto
35
35
36
36
For more control, you can create a custom environment where you can specify Python version, environment name, packages to be installed, and more!
37
37
38
-
![Gif showing environment creation using Quick Create.]()
39
-
40
38
The following environment managers are supported out of the box:
41
39
42
40
| Id | Name | Description |
@@ -51,41 +49,32 @@ Environment managers are responsible for specifying which package manager will b
51
49
52
50
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.
53
51
54
-
![ADD A QUICK REFERENCE PICTURE FOR BUTTONS]()
55
-
56
52
The extension uses `pip` as the default package manager, but you can use the package manager of your choice using the `python-envs.defaultPackageManager` setting. The following are package managers supported out of the box:
| ms-python.python:pip|`pip`| Pip acts as the default package manager and it's typically built-in to Python. |
61
57
| 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/). |
62
58
63
-
### Project Creation and Management
64
-
65
-
The Python Environments extension allows you to assign additional files or folders to various environments. Using `Add Python Project` in the Python Projects view you can:
66
-
67
-
- Add existing projects : Allows you to select a file or folder that is currently in your VS Code workspace
68
-
- Auto find projects: Searches for folders in your VS Code workspace with `pyproject.toml` and other setup files
69
-
- Create new project: Create a new project from scratch
70
-
71
-
The **Python: Create Project** command simplifies the process of starting a new Python project by scaffolding it for you. Whether in a new workspace or an existing one, this command sets up the necessary environment and files, so you don’t have to worry about the initial setup, and only the code you want to write.
59
+
## Project Management
72
60
73
-
![Gif showing project creation using the `Python: Create Project` command for a Python package.]()
61
+
A "Python Project" can be a file or folder that contains runnable Python code. With the Python Environments extension, you can add files and folders as projects and assign individual environments to them.
74
62
75
-
#### Types of Projects
63
+
Projects can be added via the Python Environments pane or in the File Explorer by right-clicking on the folder/file and selecting the "Add as Python Project" menu item.
76
64
77
-
The `Python: Create Project` command supports the following project types:
65
+
There are a couple of ways that you can add a Python Project from the Python Environments panel:
78
66
79
-
- Package: A structured Python package with files like `__init__.py` and setup configurations.
80
-
- Generic script: A simple project for standalone Python scripts, ideal for quick tasks or just to get you started.
67
+
| Name | Description |
68
+
| ----- | ---------- |
69
+
| Add Existing | Allows you to add an existing folder from the file explorer. |
70
+
| Auto find | Searches for folders that contain `pyproject.toml` or `setup.py` files |
81
71
82
72
## Command Reference
83
73
84
74
| Name | Description |
85
75
| -------- | ------------- |
86
76
| Python: Create Environment | Create a virtual environment using your preferred environment manager preconfigured with "Quick Create" or configured to your choices. |
87
77
| Python: Manage Packages | Install and uninstall packages in a given Python environment. |
88
-
| Python: Create Project | Creates a scaffolded Python project with a virtual environment. |
89
78
| Python: Activate Environment in Current Terminal | Activates the currently opened terminal with a particular environment. |
90
79
| Python: Deactivate Environment in Current Terminal | Deactivates environment in currently opened terminal. |
91
80
| Python: Run as Task | Runs Python module as a task. |
0 commit comments