Quick Start
This guide walks through creating your first project using Create Python App.
Start the Wizard
Section titled “Start the Wizard”Run:
create-python-appThe setup wizard will guide you through the project creation process.
Project Name
Section titled “Project Name”Choose a name for your project.
Example:
❯ What is your project name? my-python-appThe project name will be used when creating folders and project metadata.
Project Location
Section titled “Project Location”Choose where the project should be created.
Example:
❯ Where should we create this project? C:\Projects\my-python-appIf the specified directory does not already exist, Create Python App will create it automatically.
Editor Selection
Section titled “Editor Selection”Choose the editor you intend to use.
Example:
❯ Choose your editor: VSCodeSupported editors currently include:
- VSCode
- Cursor
- Vim
- Other
Plugin Selection
Section titled “Plugin Selection”If supported by the selected editor, optional plugins can be chosen.
Example:
❯ Select packages: Python Extension (VSCode), PylanceReview Configuration
Section titled “Review Configuration”Before creating the project, Create Python App displays a summary of the selected options.
Example:
Project: my-python-appLocation: C:\Projects\my-python-appEditor: VSCodePlugins: Python Extension (VSCode), PylanceConfirm the configuration to continue.
Project Creation
Section titled “Project Creation”Create Python App will:
- Create a virtual environment.
- Create a standard project structure.
- Generate starter files.
- Save project metadata.
- Configure editor-specific settings where applicable.
Example Project Structure
Section titled “Example Project Structure”my-python-app/├── pyproject.toml├── README.md├── src/│ ├── __init__.py│ └── app.py├── tests/│ └── test_sample.py└── docs/ └── README.mdNext Steps
Section titled “Next Steps”Once project creation is complete:
Activate the virtual environment:
.venv\Scripts\activateRun the sample application:
python src/app.pyIf using VS Code:
code .Learn More
Section titled “Learn More”After creating your first project, explore:
- Installation
- Project Structure
- VS Code Support
- Wizard Reference
