Proto Craft
A CLI tool for rapidly creating and managing development projects with FastAPI boilerplate templates and modular app structures.
Overview
Proto Craft streamlines the process of scaffolding new FastAPI-based projects and creating self-contained app modules within those projects. It provides automated setup with configurable Python versions and maintains a clean directory structure.
Features
- 🚀 Project Creation: Clone and initialize FastAPI boilerplate projects
- 📦 App Scaffolding: Create modular app structures with predefined file templates
- 🔍 Project Inspection: Verify app structure and create missing files
- 🐍 Python Version Control: Support for Python 3.10 - 3.15
- 📋 Configuration Management: builder.ini-based project configuration
Installation
Prerequisites
- Python >= 3.12
- Git
uvpackage manager (recommended)
From Source
git clone https://github.com/tinspj1997/proto-craft.git
cd proto-craft
uv sync
Install as Package
pip install proto-craft
# or with uv
uv pip install proto-craft
Quick Start
Create a New Project
proto-craft create project
Follow the interactive prompts:
- Enter your project name
- Specify the required Python version (3.10-3.15, default: 3.12)
The tool will:
- Clone the FastAPI boilerplate repository
- Remove the .git directory for a fresh start
- Create
builder.iniconfiguration - Set up
.python-versionfile
Navigate to Your Project
cd your-project-name
uv sync
Create an App Inside the Project
proto-craft create app
Provide the app name when prompted. This creates:
src/app/your-app-name/
├── __init__.py
├── routes.py
├── schema.py
└── service.py
Inspect Project Apps
Verify the structure of all apps in your project:
proto-craft inspect
Create missing files automatically:
proto-craft inspect --add
Display Version
proto-craft version
Configuration
builder.ini
Located in the project root, contains project metadata:
[project]
name = your-project-name
version = 1.0.0
python_version = 3.12
app_path = src/app
- app_path: Directory where new apps are created (relative to project root)
.python-version
Specifies the project's Python version for tools like pyenv or uv.
Project Structure
your-project-name/
├── .python-version # Python version specification
├── builder.ini # Project configuration
├── src/
│ └── app/
│ └── your-app-name/ # New apps created here
│ ├── __init__.py
│ ├── routes.py
│ ├── schema.py
│ └── service.py
├── main.py
└── [other project files]
Environment Variables
PROTO_CRAFT_PASSKEY
Optional environment variable for authentication:
export PROTO_CRAFT_PASSKEY="your-passkey"
proto-craft create project
If not set, you'll be prompted for the passkey interactively.
Development
Requirements
- Python 3.12+
- Dependencies:
typer,rich
Install Development Dependencies
cd proto-craft
uv sync --all-extras
Run Commands
# Development mode
uv run proto-craft --help
# Or install in editable mode
pip install -e .
proto-craft --help
Troubleshooting
builder.ini not found
Ensure you're running commands from the project root directory created by the tool.
cd /path/to/your/project
proto-craft inspect
app_path not configured
Edit your builder.ini and verify the [project] section contains an app_path entry.
Git clone fails
- Check your internet connection
- Verify the repository URL in
instructions.py - Ensure git is installed and accessible
Python version validation error
Specify a Python version between 3.10 and 3.15:
proto-craft create project
# When prompted: Enter a version like 3.12
Contributing
Contributions are welcome! Please:
- Fork the repository
- Create a feature branch
- Make your changes with proper type hints
- Run tests (when available)
- Submit a pull request
License
See LICENSE file in the repository.
Author
Tins P Joseph
- Email: tinspj1997@gmail.com
- GitHub: @tinspj1997
Related Projects
- FastAPI Boilerplate - The template used for project creation
Support
For issues, questions, or suggestions:
- 📝 Open an issue on GitHub
- 📧 Email the author
- 💬 Check existing documentation
Last Updated: March 2025
Version: 0.1.0
Metadata
Release files for proto-craft 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| proto_craft-0.1.0.tar.gz | 6.2 kB | Without provenance | Details for proto_craft-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| proto_craft-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for proto_craft-0.1.0-py3-none-any.whl |
Total release size: 14.9 kB
Release files / proto_craft-0.1.0.tar.gz
| Download URL | proto_craft-0.1.0.tar.gz |
|---|---|
| Size | 6.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f6963f0270432eb8b7a9a5718ad50e5e06e4394cb275cea18f5a4ff823c9345
|
|
BLAKE2b-256 checksum How to use checksums |
c699f95d06c6560dd796fd7bbf9c9929518e4e98eeaf5950650f2ced1d7b0066
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.17
|
Release files / proto_craft-0.1.0-py3-none-any.whl
| Download URL | proto_craft-0.1.0-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6cea50b19ed4be7dd27004afc7685be8c8e6a2d1e7c6fdcf763f9624d23e8a5c
|
|
BLAKE2b-256 checksum How to use checksums |
c6f596f3758e7e3e386a4be5102b2a7fe5e4082201161083ad2ddab3ec4af6b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.17
|
Security for proto-craft 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.