1
0
mirror of https://github.com/ycd/manage-fastapi.git synced 2021-11-08 01:34:39 +03:00

📝 Update index according to readme

This commit is contained in:
Marcelo Trylesinski
2020-12-02 21:30:12 +01:00
parent 78c6796674
commit 90886a8d96

View File

@@ -23,24 +23,55 @@
**Source Code**: View it on [Github](https://github.com/ycd/manage-fastapi/)
**Installation**: `pip install manage-fastapi`
---
## Features 🚀
* #### Creates customizable **project boilerplate.**
* #### Creates customizable **app boilerplate.**
* #### Handles the project structuring for you.
## Installation
Manage FastAPI can be installed by running `pip install manage-fastapi`. It requires Python 3.6+ to run.
## Usage
To get started right away with sensible defaults:
```bash
fastapi startproject {name}
```
You can run _Manage FastAPI_ as a package if running it as a script doesnt work:
```bash
python -m fastapi startproject {name}
```
## Command line options
Manage FastAPI has three commands for now. You can list them by running `fastapi --help`:
<img src="../docs_assets/fastapi-help.png" width=700>
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_assets/startproject-help.png" width=700>
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.