A CLI tool to quickly generate FastAPI project structures
Project description
Fast Create - A CLI Tool for FastAPI Projects
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
.envsupport 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fast_create-0.2.2.tar.gz.
File metadata
- Download URL: fast_create-0.2.2.tar.gz
- Upload date:
- Size: 33.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4ed50bc99372a17872c93d40825830b153437f42f17c934f05ac92033e3c3bfc
|
|
| MD5 |
f8b5eeef777c6fa547a8e38a3c7a46a5
|
|
| BLAKE2b-256 |
1169ef84bf9268ce9f9969e8b324d0e7fb658003328d455d945a4b44a4739190
|
File details
Details for the file fast_create-0.2.2-py3-none-any.whl.
File metadata
- Download URL: fast_create-0.2.2-py3-none-any.whl
- Upload date:
- Size: 45.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4594c080c8de50641fa980afb57d68094ea85a0e33a623008ee8efcf96f87a57
|
|
| MD5 |
bfdbcfa57de9b47e796bde9d15550958
|
|
| BLAKE2b-256 |
30f2bf1dae9aa1b332728dbd516549c1111a7c1f5bd051c6696bf7ca119bfd0f
|