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

Usage

# 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

Project Structure

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:

  1. Clone the repository
git clone https://github.com/raihanhd12/fastapi-project-creator.git
cd fastapi-project-creator
  1. Install in development mode
pip install -e .
  1. Make your changes and test them with
create-fastapi-app test-project

License

MIT

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_project_creator-0.1.3.tar.gz
  • Upload date:
  • Size: 6.2 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.1.3.tar.gz
Algorithm Hash digest
SHA256 b7d74bc18d58b28660200560c98fe7bcfa92f728a1ca5b4712cd23f69e775de7
MD5 26d96e427a510c2dd0cf7c6e5d1bfef3
BLAKE2b-256 87eab2d0685ad99cf7ff65181db4e7eaaa6a301ee1fb7b95f1ab13047b986bf9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_project_creator-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 012242949aab69967d524d97e4142b986edf0c8a08ea5ac4d3ef8113549274c1
MD5 3b4a199bd1bba08bcb50d156d53934fc
BLAKE2b-256 0ab7098d21d0224fea4fc5e2ee6996931293e9d62e4c2ddea7e3211721696d4e

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