FastAPI-fastkit: Fast, easy-to-use starter kit for new users of Python and FastAPI
This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and FastAPI.
This project was inspired by the SpringBoot initializer & Python Django's django-admin cli operation.
Key Features
- Immediate FastAPI project creation : Super-fast FastAPI workspace & project creation via CLI, inspired by
django-adminfeature of Python Django - Prettier CLI outputs : beautiful CLI experiment (rich library feature)
- Standards-based FastAPI project template : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
Installation
Install FastAPI-fastkit at your Python environment.
$ pip install FastAPI-fastkit
---> 100%
Usage
Create a new FastAPI project workspace environment immediately
You can now start new FastAPI project really fast with FastAPI-fastkit!
Create a new FastAPI project workspace immediately with:
$ fastkit init
Enter the project name: <your-project-name>
Enter the author name: <your-name>
Enter the author email: <your-email>
Enter the project description: <your-project-description>
Available Stacks and Dependencies:
MINIMAL Stack
┌──────────────┬─────────┐
│ Dependency 1 │ fastapi │
│ Dependency 2 │ uvicorn │
└──────────────┴─────────┘
STANDARD Stack
┌──────────────┬────────────┐
│ Dependency 1 │ fastapi │
│ Dependency 2 │ uvicorn │
│ Dependency 3 │ sqlalchemy │
│ Dependency 4 │ alembic │
│ Dependency 5 │ pytest │
└──────────────┴────────────┘
FULL Stack
┌──────────────┬────────────────┐
│ Dependency 1 │ fastapi │
│ Dependency 2 │ uvicorn │
│ Dependency 3 │ sqlalchemy │
│ Dependency 4 │ alembic │
│ Dependency 5 │ pytest │
│ Dependency 6 │ redis │
│ Dependency 7 │ celery │
│ Dependency 8 │ docker-compose │
└──────────────┴────────────────┘
Select stack (minimal, standard, full): minimal
Creating Project:
new-fastapi-project
┌───────────┬────────┐
│ Component │ Status │
│ fastapi │ ✓ │
│ uvicorn │ ✓ │
└───────────┴────────┘
Creating virtual environment...
Installing dependencies...
⠙ Setting up project environment...Collecting <packages~>
---> 100%
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ✨ Dependencies installed successfully │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ✨ FastAPI project '<your-project-name>' has been created successfully and saved to '<your-project-path>'! │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ℹ To start your project, run 'fastkit runserver' at newly created FastAPI project directory │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
This command will create a new FastAPI project workspace environment with Python virtual environment.
Add a new route to the FastAPI project
FastAPI-fastkit makes it easy to expand your FastAPI project.
Add a new route endpoint to your FastAPI project with:
$ fastkit addroute <your-project-name> <new-route-name>
---> 100%
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ℹ Updated main.py to include the API router │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ✨ Successfully added new route '<new-route-name>' to project '<your-project-name>'. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Place a structured FastAPI demo project immediately
You can also start with a structured FastAPI demo project.
Demo projects are consist of various tech stacks with simple item CRUD endpoints implemented.
Place a structured FastAPI demo project immediately with:
$ fastkit startdemo
Enter the project name: <your-project-name>
Enter the author name: <your-name>
Enter the author email: <your-email>
Enter the project description: <your-project-description>
Deploying FastAPI project using 'fastapi-default' template
Template path:
/<fastapi_fastkit-package-path>/fastapi_project_template/fastapi-defau
lt
Project Information
┌──────────────┬──────────────────────────────────────────┐
│ Project Name │ <your-project-name> │
│ Author │ <your-name> │
│ Author Email │ <your-email> │
│ Description │ <your-project-description> │
└──────────────┴──────────────────────────────────────────┘
Do you want to proceed with project creation? [y/N]: y
FastAPI template project will deploy at '<your-project-path>'
---> 100%
╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
│ ✨ FastAPI project '<your-project-name>' from 'fastapi-default' has been created and saved to │
│ <your-project-path>! │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
To view the list of available FastAPI demos, check with:
$ fastkit list-templates
Significance of FastAPI-fastkit
FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the FastAPI 0.111.0 version update.
As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice the wonderful motivation that FastAPI developer tiangolo has.
License
This project is licensed under the MIT License - see the LICENSE file for details.
@author bnbong bbbong9@gmail.com
Metadata
Release files for FastAPI-fastkit 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fastapi_fastkit-1.0.0.tar.gz | 64.5 kB | With provenance | Details for fastapi_fastkit-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fastapi_fastkit-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for fastapi_fastkit-1.0.0-py3-none-any.whl |
Total release size: 177.3 kB
Release files / fastapi_fastkit-1.0.0.tar.gz
| Download URL | fastapi_fastkit-1.0.0.tar.gz |
|---|---|
| Size | 64.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
23d9725fd786b804b6dbaa39669ff471c12d372850dc2bfd6365b9d4aa702f54
|
|
BLAKE2b-256 checksum How to use checksums |
02312614832040ef9bb4688916e18a4638bc52a0e0c8a4f07f821ad82c6e323f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 1, 2025.
Transparency logRelease files / fastapi_fastkit-1.0.0-py3-none-any.whl
| Download URL | fastapi_fastkit-1.0.0-py3-none-any.whl |
|---|---|
| Size | 112.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3c44e29900c45c184deaed129c07ae2dba6d6acf226681d4973386f11f4825d0
|
|
BLAKE2b-256 checksum How to use checksums |
29dfc976449afc198ed60fc28edc24fed7494277efec3e1e86b89cb47222d9f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 1, 2025.
Transparency logSecurity for FastAPI-fastkit 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for fastapi_fastkit-1.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 1, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.