Skip to content

Quick Start

This guide walks through creating your first project using Create Python App.

Run:

Terminal window
create-python-app

The setup wizard will guide you through the project creation process.

Choose a name for your project.

Example:

❯ What is your project name? my-python-app

The project name will be used when creating folders and project metadata.

Choose where the project should be created.

Example:

❯ Where should we create this project? C:\Projects\my-python-app

If the specified directory does not already exist, Create Python App will create it automatically.

Choose the editor you intend to use.

Example:

❯ Choose your editor: VSCode

Supported editors currently include:

  • VSCode
  • Cursor
  • Vim
  • Other

If supported by the selected editor, optional plugins can be chosen.

Example:

❯ Select packages: Python Extension (VSCode), Pylance

Before creating the project, Create Python App displays a summary of the selected options.

Example:

Project: my-python-app
Location: C:\Projects\my-python-app
Editor: VSCode
Plugins: Python Extension (VSCode), Pylance

Confirm the configuration to continue.

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.
my-python-app/
├── pyproject.toml
├── README.md
├── src/
│ ├── __init__.py
│ └── app.py
├── tests/
│ └── test_sample.py
└── docs/
└── README.md

Once project creation is complete:

Activate the virtual environment:

Terminal window
.venv\Scripts\activate

Run the sample application:

Terminal window
python src/app.py

If using VS Code:

Terminal window
code .

After creating your first project, explore:

  • Installation
  • Project Structure
  • VS Code Support
  • Wizard Reference