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

📝 Update index documentation

This commit is contained in:
Marcelo Trylesinski
2020-11-25 03:38:08 +01:00
parent de640a4489
commit f7cf8af472
2 changed files with 7 additions and 37 deletions

View File

@@ -13,6 +13,7 @@ The package plans are here. If you want to contribute with new ideas, or develop
* [X] Add basic linter tools on `startproject` (flake8, mypy and isort).
* [X] Add `.pre-commit-config.yaml` on `startproject`.
* [X] Integrate databases on `startproject`.
- [X] Postgres
* [ ] Different Authentication support on `startproject`.
* [ ] Add tests.
* [ ] Fix documentation accordingly.

View File

@@ -1,18 +1,16 @@
<h3 align="center">
<strong>Managing FastAPI projects made easy.</strong>
<strong>Manage FastAPI projects easily</strong>
</h3>
<p align="center">
<img src="https://img.shields.io/github/issues/ycd/manage-fastapi?style=for-the-badge">
<a href="https://github.com/ycd/manage-fastapi" target="_blank">
<img src="https://img.shields.io/bitbucket/pr-raw/ycd/manage-fastapi?style=for-the-badge" alt="Build">
</a>
<a href="https://github.com/ycd/manage-fastapi" target="_blank">
<img src="https://img.shields.io/github/last-commit/ycd/manage-fastapi?style=for-the-badge" alt="Latest Commit">
</a>
<img src="https://img.shields.io/github/workflow/status/ycd/manage-fastapi/Test?style=for-the-badge">
<img src="https://img.shields.io/codecov/c/github/ycd/manage-fastapi?style=for-the-badge">
<br />
<a href="https://pypi.org/project/fastapi-utils" target="_blank">
<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">
@@ -20,6 +18,7 @@
</p>
---
**Documentation**: View it on [website](https://ycd.github.io/manage-fastapi/)
@@ -36,8 +35,7 @@
* #### Creates customizable **project boilerplate.**
* #### Creates customizable **app boilerplate.**
* #### Handles the project structing for you.
* #### Get fancy information about your Pydantic models.
* #### Handles the project structuring for you.
@@ -67,35 +65,6 @@ fastproject/
└── __init__.py
```
## Getting information about our Pydantic models.
```
manage-fastapi showmodels
```
## With this command we are getting a fancy output of our models.
```
╔════════════════════════════════╗
║ item.py ║
║ ------- ║
║ ItemBase ║
║ ItemCreate ║
║ ItemUpdate ║
║ ItemInDBBase ║
║ Item ║
║ ItemInDB ║
╚════════════════════════════════╝
╔════════════════════════════════╗
║ token.py ║
║ -------- ║
║ Token ║
║ TokenPayload ║
╚════════════════════════════════╝
```
## Installation 📌
`pip install manage-fastapi`