Metadata-Version: 2.1
Name: fastapi-cli-service
Version: 1.0.1
Summary: Managing FastAPI projects made easy.
Home-page: https://github.com/sxhxliang/fastapi-cli
Author: liangshihua
Author-email: shxh.liang@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6.1,<4.0.0
Description-Content-Type: text/markdown
Requires-Dist: bullet (<3.0.0,>=2.2.0)
Requires-Dist: cookiecutter (<2.0.0,>=1.7.2)
Requires-Dist: pydantic[email] (<2.0.0,>=1.7.2)
Requires-Dist: typer (<0.4.0,>=0.3.2)

<h3 align="center">
    <strong>Project generator and manager for FastAPI.</strong>
</h3>
<p align="center">
    <a href="https://github.com/sxhxliang/fastapi-cli" target="_blank">
        <img src="https://img.shields.io/github/last-commit/sxhxliang/fastapi-cli?style=for-the-badge" alt="Latest Commit">
    </a>
        <img src="https://img.shields.io/github/workflow/status/sxhxliang/fastapi-cli/Test?style=for-the-badge">
        <img src="https://img.shields.io/codecov/c/github/sxhxliang/fastapi-cli?style=for-the-badge">
    <br />
    <a href="https://pypi.org/project/manage-fastapi" target="_blank">
        <img src="https://img.shields.io/pypi/v/manage-fastapi?style=for-the-badge" alt="Package version">
    </a>
    <img src="https://img.shields.io/pypi/pyversions/manage-fastapi?style=for-the-badge">
    <img src="https://img.shields.io/github/license/sxhxliang/fastapi-cli?style=for-the-badge">
</p>




---

**Source Code**: View it on [Github](https://github.com/sxhxliang/fastapi-cli)

---

##  Features 🚀

* #### Creates customizable **project boilerplate.**
* #### Creates customizable **app boilerplate.**
* #### Handles the project structuring for you.
* #### Optional Dockerfile generation.
* #### Optional docker-compose generation for your project needs.
* #### Optional pre-commit hook generation.


## Installation 📌

* Prerequisites
    * Python 3.6 +

Manage FastAPI can be installed by running 

```python

pip3 install git+https://github.com/sxhxliang/fastapi-cli
# or
git clone https://github.com/sxhxliang/fastapi-cli
cd fastapi-cli && python3 setup.py develop
```


## Getting started 🎈

Easiest way to start is using the defaults:

```bash
fastapi startproject [name]
```

But there is an **interactive** mode!

```bash
fastapi startproject [name] --interactive
```



## Command line options 🧰

Manage FastAPI provides three different commands. 

You can list them with

```bash
fastapi --help
```

<img src="docs/docs_assets/fastapi-help.png" width=600>

The idea is to have a highly customizable CLI, but at the same time a simple interface for new users. You can see the available options for `startproject` running `fastapi startproject --help`:

<img src="docs/docs_assets/startproject-help.png" width=600>

The other commands are already available but the current implementation is too shallow. More details about `startapp` and `run` commands will be provided once they have more functionalities, at the moment you can run `startapp` by just:

```bash
fastapi startapp {name}
```

On the other hand, the `run` command expects you to have a `startproject` structure:

```bash
fastapi run
```

## License

This project is licensed under the terms of the MIT license.


