Skip to main content

A simple FastAPI factory for creating FastAPI applications.

Project description

FastAPI Builder

FastApiFy is a command-line tool designed to streamline the creation of well-organized file structures for FastAPI projects. It enables developers to kickstart their projects with best practices in mind, reducing boilerplate and setup time.

Features

  • Automated File Structure Creation: Generate a production-ready project structure in seconds.
  • Customizable Templates: Define your own templates to suit your development style.
  • Extensible Commands: Add custom commands to extend functionality.
  • User-Friendly Interface: Simple CLI commands for intuitive usage.

Installation

Install FastApiFy via pip:

pip install fastapify

Usage

Create a New Project

To create a new FastAPI project, run:

fastapify startproject my-fastapi-project

This will scaffold a directory structure with the following layout:

my-fastapi-project/
├── .envs/
│   ├── .local/
│   │      ├── .db
│   │      └── .web
│   └── .prod/
│   
├── compose/
│   ├── local/
│   │      └── django/
│   │            └── Dockerfile
│   └── prod/
│          └── django/ 
├── core
│   ├── config.py
│   ├── database.py
│   └── middlewares.py
│  
├── requirements/
│   ├── base.txt
│   └── local.txt
│  
├── src/
│   ├── __init__.py
│   └── api.py
│
├── local.yml
├── prod.yml
└── README.md

Create new App

Easily add new applications to your project with:

fastapify startapp myapp

This creates src/myapp/ with the following structure:

app structure:

myapp/
├── __init__.py
├── admin.py
├── models.py
├── router.py
├── schemas.py
└── service.py

Contributing

Contributions are welcome! If you have ideas for new features or improvements, feel free to fork the repository and create a pull request.

  1. Fork the repository
  2. Create a new branch
  3. Commit your changes
  4. Push to the branch
  5. Open a pull request

License

FastApiFy is open-source software licensed under the MIT License. See the LICENSE file for details.


Acknowledgments

  • Inspired by the simplicity and power of FastAPI.
  • Thanks to the open-source community for providing valuable resources and inspiration.

Get started today with FastApiFy and make your API development fast, efficient, and fun!

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

fastapify-0.0.18.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

fastapify-0.0.18-py2.py3-none-any.whl (10.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file fastapify-0.0.18.tar.gz.

File metadata

  • Download URL: fastapify-0.0.18.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for fastapify-0.0.18.tar.gz
Algorithm Hash digest
SHA256 35f21fee792a4eb5394013e383119e95e93690bf6854b8207b28fb08c7ad8d45
MD5 09b2af74d31a8dce10f4ad778cacdbe0
BLAKE2b-256 b6a9dee6b23fc3b676fc09fa6904ad7deca949e396950ad3d055879165a49cd8

See more details on using hashes here.

File details

Details for the file fastapify-0.0.18-py2.py3-none-any.whl.

File metadata

  • Download URL: fastapify-0.0.18-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for fastapify-0.0.18-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a9d862abdfe87a1f95dcdfc36bf7e9888da1a3787bedcf5d19be1f499f3d4a19
MD5 905c4b31aaa621c6580925d93ae23ec7
BLAKE2b-256 73ff7f3aa3fb5c0d626d050f0a340f9871089f781110b365d0eabdb0776717ea

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