Skip to main content

CLI tool to generate FastAPI project structure

Project description

FastAPI Generator

A simple CLI tool to generate FastAPI project structure with best practices, ready-to-use configuration, and organized folder structure.

Installation

# Install from PyPI
pip install fastapi-project-creator

Or install directly from GitHub

pip install git+https://github.com/raihanhd12/fastapi-project-creator.git

Note: Requires Python 3.7 or higher.

Create a new FastAPI project

create-fastapi-app my-project-name

This will generate a complete FastAPI project structure with the following features:

  • Organized directory structure following best practices
  • Pre-configured API router setup with controllers and services
  • Database connection with SQLAlchemy
  • Environment variable configuration with host and port settings
  • Ready-to-use project structure with proper entry point
my-project-name/
├── app/
│ ├── api/
│ │ ├── endpoints/
│ │ │ └── **init**.py
│ │ ├── **init**.py
│ │ └── api.py
│ ├── controllers/
│ │ ├── **init**.py
│ │ └── base_controller.py
│ ├── core/
│ │ ├── **init**.py
│ │ └── config.py
│ ├── db/
│ │ ├── **init**.py
│ │ └── session.py
│ ├── models/
│ │ └── **init**.py
│ ├── schemas/
│ │ └── **init**.py
│ ├── services/
│ │ ├── **init**.py
│ │ └── base_service.py
│ ├── utils/
│ │ └── **init**.py
│ ├── **init**.py
│ └── main.py
├── tests/
├── .env
├── .gitignore
├── main.py
├── requirements.txt
└── README.md

Development

To contribute to this project:

Clone the repository

git clone https://github.com/raihanhd12/fastapi-project-creator.git
cd fastapi-project-creator

Install in development mode

pip install -e .

Make your changes and test them with

create-fastapi-app test-project

License MIT For more information, visit the project homepage. To report issues, please use the issue tracker.

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

fastapi_project_creator-0.2.2.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

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

fastapi_project_creator-0.2.2-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_project_creator-0.2.2.tar.gz.

File metadata

  • Download URL: fastapi_project_creator-0.2.2.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for fastapi_project_creator-0.2.2.tar.gz
Algorithm Hash digest
SHA256 eaff8851265f199b92721c66989b58ec630061d994b3e3d0737e2b4b939b6d10
MD5 54f28142061b36f502d23afa83b5ef0b
BLAKE2b-256 e4637a9f0dac539d84407f9565eaa43a7539d61f9737b24770f1b04fd7abf025

See more details on using hashes here.

File details

Details for the file fastapi_project_creator-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_project_creator-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9859d2d98faeff8bffada7902b5a856c8a7692ef0537ddfb4dff7e27e1012250
MD5 1d22c94e5bc9e1af1423a3dbd0d428bf
BLAKE2b-256 0589d53efea2068b7ec679731d259fc43723a94f1cf44c5a39ecca3afdb173aa

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