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 [email protected]