Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"charliermarsh.ruff",
"ms-python.python",
"ms-python.vscode-pylance"
]
}
12 changes: 12 additions & 0 deletions .vscode/settings.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
{
"python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
"editor.formatOnSave": true,
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
}
},
"python.analysis.typeCheckingMode": "basic"
}
41 changes: 41 additions & 0 deletions AGENTS.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
# Agent Instructions for create-python-app

## Overview

`create-python-app` is a CLI tool for scaffolding Python projects from templates
(parity with [Create-Node-App/create-node-app](https://github.com/Create-Node-App/create-node-app)).

Roadmap: [#1](https://github.com/Create-Python-App/create-python-app/issues/1).

## Tech Stack

- Python 3.12+ (see `.python-version`)
- [uv](https://docs.astral.sh/uv/) workspaces (virtual root + `packages/*`)
- Typer (CLI — Epic 4)
- Ruff (lint/format — Epic 2)
- Pyright (types — Epic 2)
- pytest (tests — Epic 2)

## Packages

| Package | Role |
|---------|------|
| `create-python-app-core` | Scaffolding engine |
| `create-awesome-python-app` | User-facing CLI (`uvx` / console script) |

## Key Commands

```bash
uv sync
make test # uv run pytest
make lint # uv run ruff check .
make typecheck # uv run pyright
make build # uv build --all
uv run create-awesome-python-app --help
```

## Code Style

- Ruff for lint + format
- Pyright for type checking
- Prefer minimal, issue-linked changes; English for commits/PRs