Ship Python Template

A GitHub template for multi-platform Python applications with FastAPI backend, React frontend, and Electron desktop support.

This template is a companion to the book Ship Python, Orchestrate AI: Professional Python in the AI Era by Michael Borck.

Quick Start

1. Click "Use this template" on GitHub
2. Clone your new repository
3. Run the rename script to customize:

./scripts/rename_project.sh "My Application" "my-application" "my_application"

Or manually search and replace:

• My Application → Your project name
• my-application → Your project slug (URL-safe)
• my_app → Your Python package name

Development

Backend

cd backend
uv sync
uv run uvicorn my_app.main:app --reload

API available at http://localhost:8000

Frontend

cd frontend
npm install
npm run dev

Frontend available at http://localhost:5173

Docker (Full Stack)

docker-compose -f docker/docker-compose.yml up

Project Structure

ship-python-template/
├── backend/           # FastAPI backend (Python)
│   ├── src/my_app/
│   └── tests/
├── frontend/          # React frontend (TypeScript)
│   └── src/
├── electron/          # Desktop wrapper
├── docker/            # Container configs
├── .github/workflows/ # CI/CD
├── CLAUDE.md          # AI context
└── scripts/           # Utility scripts

Features

• FastAPI Backend: Modern Python API with automatic documentation
• React Frontend: TypeScript + Vite + React Query
• Electron Desktop: Cross-platform with auto-update
• Docker: Development and production containers
• CI/CD: GitHub Actions workflows
• AI-Ready: CLAUDE.md for AI assistant context

Related Resources

• Ship Python, Orchestrate AI - The companion book
• ship-python-cookiecutter - Cookiecutter template (more customization)
• ship-python-example - Complete working example

License

MIT License - see LICENSE for details.