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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fast_create-0.1.4.tar.gz
  • Upload date:
  • Size: 3.2 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.4.tar.gz
Algorithm Hash digest
SHA256 073403deafb4bf7d5943d00a2ca42459fda30c693947aa9c311603f319659ea6
MD5 ef111730dac7ff5848eea83686c218c5
BLAKE2b-256 70573fb91772ea4f36e765029c5606bc06d16ead09d157cb0dd1b212c548a255

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fast_create-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8a6f072fc7fa6532d935bcf4f90a83a546ae5d92acef9c055354049fc891640d
MD5 40d94269c43cae4ac7dfdfc70defb850
BLAKE2b-256 832895231bac799540e108d74fbe2a265c212dac9a055f86dd68f021952d480f

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