Metadata-Version: 2.1
Name: FastAPI-fastkit
Version: 0.1.1
Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
Author-Email: bnbong <bbbong9@gmail.com>
License: MIT
Requires-Python: >=3.12
Requires-Dist: click>=8.1.7
Requires-Dist: rich>=13.9.2
Requires-Dist: fastapi-cli>=0.0.5
Provides-Extra: dev
Requires-Dist: pytest>=8.3.3; extra == "dev"
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
Requires-Dist: black>=24.10.0; extra == "dev"
Requires-Dist: pre-commit>=4.0.1; extra == "dev"
Requires-Dist: mypy>=1.12.0; extra == "dev"
Requires-Dist: isort>=5.13.2; extra == "dev"
Description-Content-Type: text/markdown

<p align="center">
    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
</p>
<p align="center">
<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
</p>
<p align="center">
<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
</a>
<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
</a>
</p>

---

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](https://github.com/fastapi/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-admin`feature of [Python Django](https://github.com/django/django)
- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) 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.

```console
$ pip install FastAPI-fastkit

---> 100%
```

## Usage

### Create a new FastAPI project workspace environment immediately

Create a new FastAPI project workspace with:

```console
$ fastkit startproject
Enter project name: <your-project-name>

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 ────────────────────────────────────────────────────────────────────╮
│ ✨ Project '<your-project-name>' has been created successfully!                                                                                │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭───────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────╮
│ ℹ To activate the virtual environment, run:                                                                                                    │
│                                                                                                                                                │
│     source /<new-venv-path>/venv/bin/activate                                                                                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

This command will create a new FastAPI project workspace environment with Python virtual environment.

### Place a structured FastAPI project immediately

Place a structured FastAPI project immediately with:

```console
$ fastkit startup
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>!                                                                                                                           │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## 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](https://github.com/fastapi/fastapi/releases/tag/0.111.0).

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](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

@author bnbong bbbong9@gmail.com
