Skip to main content

CLI para gerar scaffolding de projetos FastAPI

Project description

fast-scaffold 🚀

CLI to generate FastAPI project scaffolding in a fast, standardized, and extensible way.

fast-scaffold creates the initial structure of a FastAPI project using Mako templates, allowing for easy evolution into multiple types of scaffolds in the future.


✨ Features

  • 📦 Simple and fast CLI
  • ⚡ Generate FastAPI projects in seconds
  • 🧱 Template-based structure (Mako)
  • 🧩 Easy to extend for new scaffolds
  • 🐍 Compatible with Python 3.10+

📦 Installation

Using pipx (recommended for CLIs)

pipx install fast-scaffold

Or using pip:

pip install fast-scaffold

🚀 Quick Start

Create a new FastAPI project:

fast-scaffold project init my-api

This will generate the project structure in the current directory:

my-api/
├── pyproject.toml
├── README.md
└── app/
    └── main.py

🧠 How it works

fast-scaffold utilizes Mako templates located within the package:

fast_scaffold/
└── templates/
    └── project/
        ├── pyproject.toml.mako
        ├── README.md.mako
        └── app/
            └── main.py.mako

🛠️ Local Development

Clone the repository and install the dependencies:

poetry install

Run the CLI locally:

poetry run fast-scaffold project init my-api

📄 Requirements

  • Python >= 3.10
  • Poetry (for development)
  • pipx (recommended for global use)

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

##📜 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fast_scaffold-0.2.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fast_scaffold-0.2.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file fast_scaffold-0.2.0.tar.gz.

File metadata

  • Download URL: fast_scaffold-0.2.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.12.3 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for fast_scaffold-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3de0d8abf7a71e97a5f9ef9239d58ba304a25e125aa7c178e38cd8950daaeae0
MD5 de13e1da9559de616a94b0b21f6603ed
BLAKE2b-256 a7f0183fcaee8cd1921144e2429880be7d52d18ed6ce3781be3bf6509e40b41d

See more details on using hashes here.

File details

Details for the file fast_scaffold-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: fast_scaffold-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.12.3 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for fast_scaffold-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 069483fd860459ce1cacb729a0d68c33e03a1d98365c3fb2b1551f65882c1811
MD5 c35ffecfa4513759eef881e779878db5
BLAKE2b-256 5b0da5ab57e29b76ada5f6664fb56333ac01b65e18d17dd4f19f629a94de7691

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page