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.1.6.tar.gz (13.7 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.1.6-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fast_create-0.1.6.tar.gz
  • Upload date:
  • Size: 13.7 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.1.6.tar.gz
Algorithm Hash digest
SHA256 c4db4664b2c0ee13042ac85e2e1bec62c38c172190ca9cc797b4e27446b994d4
MD5 0095ee418cac1ea9cfcbd0e553a22bcb
BLAKE2b-256 1813f271b10b8432f659b61a477139570c93460ba9068467fb080f9ffcff02fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fast_create-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 3.2 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.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b862cbb9a60b588bf62c6e6cdab81bec53d7f6c79fabfc561d2e5fc579c32ca1
MD5 d05a6ae1b3982fd68c0de56505244d4e
BLAKE2b-256 8d837282df9a546d2d01af868f9767ad6c023fbb15eecda8b86133330384e4c7

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