Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ycd/manage-fastapi

:rocket: CLI tool for FastAPI. Generating new FastAPI projects & boilerplates made easy.
https://github.com/ycd/manage-fastapi

boilerplate cli databases fastapi mongodb mysql postgresql project-generator project-management project-management-tool sqlite tortoise-orm

Last synced: 2 months ago
JSON representation

:rocket: CLI tool for FastAPI. Generating new FastAPI projects & boilerplates made easy.

Lists

README

        


manage-fastapi

[manage-fastapi](https://github.com/ycd/manage-fastapi) Project generator and manager for FastAPI

![manage_fastapi](assets/readme.gif)



Latest Commit






Package version




---

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

---

## 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.7 +

Manage FastAPI can be installed by running

```python
pip install manage-fastapi
```

## 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
```

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`:

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.