Skip to main content

A CLI tool to quickly generate FastAPI project structures

Project description

Fast Create - A CLI Tool for FastAPI Projects

FastAPI

Fast Create is a command-line tool that allows you to quickly generate FastAPI project structures with best practices. It automates project setup, dependencies, and server startup, making FastAPI development seamless.

๐Ÿš€ Features

  • ๐Ÿ“‚ Auto-generates FastAPI project structure
  • ๐Ÿ”ง Pre-configured settings for FastAPI, Uvicorn, and Pydantic
  • ๐Ÿš€ Automatically starts the Uvicorn server after project creation
  • ๐Ÿ› ๏ธ Includes .env support for configurations
  • โœ… Lightweight and easy to use

๐Ÿ“Œ Installation

You can install fast-create from PyPI:

pip install fast-create

๐Ÿ› ๏ธ Usage

Create a New FastAPI Project

To generate a new FastAPI project, run:

fast-create new myapp

Replace myapp with your desired project name.

Folder Structure Generated

After running the command, the following project structure will be created:

myapp/
โ”‚โ”€โ”€ app/
โ”‚   โ”œโ”€โ”€ main.py  # Entry point
โ”‚   โ”œโ”€โ”€ routes/
โ”‚   โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”‚   โ”œโ”€โ”€ user.py
โ”‚   โ”œโ”€โ”€ models/
โ”‚   โ”œโ”€โ”€ schemas/
โ”‚   โ”œโ”€โ”€ services/
โ”‚โ”€โ”€ .env  # Environment variables
โ”‚โ”€โ”€ requirements.txt
โ”‚โ”€โ”€ README.md
โ”‚โ”€โ”€ Dockerfile
โ”‚โ”€โ”€ .gitignore

โšก Running the Server

After creating the project, the Uvicorn server starts automatically. However, you can manually start the server anytime:

cd myapp
uvicorn app.main:app --reload

๐Ÿ”ง Configuration

Environment Variables

Your .env file should contain:

SECRET_KEY=your-secret-key
DATABASE_URL=sqlite:///./database.db
MAIL_PASSWORD=your-mail-password

Ensure you update this file with your actual credentials.


๐Ÿ“œ License

This project is licensed under the MIT License.


๐Ÿ’ก Contributing

We welcome contributions! Feel free to fork this repo, create a new branch, and submit a pull request.


๐Ÿ“ฉ Contact

For issues or suggestions, open an issue or reach out at joechristophersc@email.com.

Happy coding! ๐ŸŽ‰

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_create-0.2.0.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

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

fast_create-0.2.0-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fast_create-0.2.0.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for fast_create-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0ab2f5fee3431025281aeadc9d9916466957823428187fc8209e4faa5d60725f
MD5 331a610594d268e7a2d276c0d138fb06
BLAKE2b-256 0cfb91217a2b78b49a410b398be751f0584766bb8bca2a6e77c9cde714e0b0a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fast_create-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 52.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for fast_create-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 309471eed7f23054842736d91c3274a2679a9eda29c0b65d5abe0fa4eb130d10
MD5 29b4b9d7eabf5ce2d5c175e56fbaa2ee
BLAKE2b-256 4a22f551c3dc5623f3a3fbdf681dffdf37576df9d6d20e675c325867f489efd1

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