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: 28 days ago
JSON representation
:rocket: CLI tool for FastAPI. Generating new FastAPI projects & boilerplates made easy.
- Host: GitHub
- URL: https://github.com/ycd/manage-fastapi
- Owner: ycd
- License: mit
- Created: 2020-08-06T23:40:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T21:16:58.000Z (8 months ago)
- Last Synced: 2024-09-29T02:21:20.268Z (about 1 month ago)
- Topics: boilerplate, cli, databases, fastapi, mongodb, mysql, postgresql, project-generator, project-management, project-management-tool, sqlite, tortoise-orm
- Language: Python
- Homepage: https://github.com/ycd/manage-fastapi
- Size: 4.46 MB
- Stars: 1,667
- Watchers: 21
- Forks: 106
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: ROADMAP.md
Awesome Lists containing this project
- awesome-fastapi - Manage FastAPI - CLI tool for generating and managing FastAPI projects. (Third-Party Extensions / Developer Tools)
- awesome-fastapi - :octocat: manage-fastapi :star: 900+ :fork_and_knife: 60+ - CLI tool for FastAPI. Generating new FastAPI projects & boilerplates made easy. (Commands)
- awesome-fastapi - Manage FastAPI - CLI tool for generating and managing FastAPI projects. (Third-Party Extensions / Developer Tools)
- jimsghstars - ycd/manage-fastapi - :rocket: CLI tool for FastAPI. Generating new FastAPI projects & boilerplates made easy. (Python)
README
manage-fastapi
[manage-fastapi](https://github.com/ycd/manage-fastapi) Project generator and manager for FastAPI
---
**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.