Skip to content

Commit 5187c7e

Browse files
authored
Update readme for create project (#562)
Update readme to include Create Project from Template
1 parent e88993e commit 5187c7e

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Python Environments (experimental)
1+
# Python Environments (preview)
22

33
## Overview
44

@@ -62,22 +62,32 @@ A "Python Project" is any file or folder that contains runnable Python code and
6262

6363
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.
6464

65-
There are a couple of ways that you can add a Python Project from the Python Environments panel:
65+
There are a few ways to add a Python Project from the Python Environments panel:
6666

6767
| Name | Description |
6868
| ------------ | ---------------------------------------------------------------------- |
6969
| Add Existing | Allows you to add an existing folder from the file explorer. |
7070
| Auto find | Searches for folders that contain `pyproject.toml` or `setup.py` files |
71+
| Create New | Creates a new project from a template. |
72+
73+
#### Create New Project from Template
74+
The **Python Envs: Create New Project from Template** 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 configures the environment and boilerplate file structure, so you don’t have to worry about the initial setup, and only the code you want to write. There are currently two project types supported:
75+
76+
- Package: A structured Python package with files like `__init__.py` and setup configurations.
77+
- Script: A simple project for standalone Python scripts, ideal for quick tasks or just to get you started.
7178

7279
## Command Reference
7380

81+
All commands can be accessed via the Command Palette (`ctrl/cmd + Shift + P`):
82+
7483
| Name | Description |
7584
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
76-
| Python: Create Environment | Create a virtual environment using your preferred environment manager preconfigured with "Quick Create" or configured to your choices. |
77-
| Python: Manage Packages | Install and uninstall packages in a given Python environment. |
78-
| Python: Activate Environment in Current Terminal | Activates the currently opened terminal with a particular environment. |
79-
| Python: Deactivate Environment in Current Terminal | Deactivates environment in currently opened terminal. |
80-
| Python: Run as Task | Runs Python module as a task. |
85+
| Create Environment | Create a virtual environment using your preferred environment manager preconfigured with "Quick Create" or configured to your choices. |
86+
| Manage Packages | Install and uninstall packages in a given Python environment. |
87+
| Activate Environment in Current Terminal | Activates the currently opened terminal with a particular environment. |
88+
| Deactivate Environment in Current Terminal | Deactivates environment in currently opened terminal. |
89+
| Run as Task | Runs Python module as a task. |
90+
| Create New Project from Template | Creates scaffolded project with virtual environments based on a template. |
8191

8292
## Settings Reference
8393

0 commit comments

Comments
 (0)