Wizard Reference
Wizard Reference
Section titled “Wizard Reference”This page is generated automatically from source code documentation.
Step 1: Project Name
Section titled “Step 1: Project Name”Description
Section titled “Description”The name of your new Python project; this will also form the base of the virtual environment.
string
Default
Section titled “Default”my-python-app
Example
Section titled “Example”my-cool-app
Step 2: Project Dir
Section titled “Step 2: Project Dir”Description
Section titled “Description”Where the new project should be created. Defaults to the root of the current drive plus the project name.
string
Default
Section titled “Default”C:\\my-python-app
Example
Section titled “Example”C:\\Projects\\my-cool-app
Step 3: Editor
Section titled “Step 3: Editor”Description
Section titled “Description”Choose your preferred editor for this project. VSCode is auto-detected if available.
string
Options
Section titled “Options”VSCodePyCharmVimOther
Example
Section titled “Example”VSCode
Step 4: Plugins
Section titled “Step 4: Plugins”Description
Section titled “Description”Pick optional editor extensions to install. Currently available when VSCode is selected.
array[string]
Example
Section titled “Example”PylanceJupyter
Step 5: Confirmation
Section titled “Step 5: Confirmation”Description
Section titled “Description”Displays a summary of the selected options and requests confirmation before project generation begins.
boolean
Default
Section titled “Default”true
Example
Section titled “Example”Yes
Step 6: Create Virtual Environment
Section titled “Step 6: Create Virtual Environment”Description
Section titled “Description”Creates a Python virtual environment for the new project.
operation
Step 7: Create Project Folders
Section titled “Step 7: Create Project Folders”Description
Section titled “Description”Creates the standard project directory structure, including source code, tests, and documentation folders.
operation
Step 8: Create Project Files
Section titled “Step 8: Create Project Files”Description
Section titled “Description”Creates the initial project files required for development.
operation
Step 9: Vscode Plugins
Section titled “Step 9: Vscode Plugins”Description
Section titled “Description”Installs selected VSCode extensions automatically.
array[string]
Example
Section titled “Example”PylancePython Debugger
Step 10: Save Metadata
Section titled “Step 10: Save Metadata”Description
Section titled “Description”Saves the selected configuration options to a JSON file for future reference.
object
Fields
Section titled “Fields”| Field | Description |
|---|---|
project_name |
|
project_path |
|
editor |
|
plugins |
|
venv_path |
Step 11: Setup Summary
Section titled “Step 11: Setup Summary”Description
Section titled “Description”Displays a final summary of the completed project configuration.
object
Fields
Section titled “Fields”| Field | Description |
|---|---|
project_name |
|
project_path |
|
editor |
|
plugins |
|
venv_path |
Step 12: Next Steps
Section titled “Step 12: Next Steps”Description
Section titled “Description”Displays guidance on activating the virtual environment, opening the project, and beginning development.
object
Fields
Section titled “Fields”| Field | Description |
|---|---|
project_path |
|
venv_path |
|
editor |