alihan/manage-fastapi
1
0
Fork 0
mirror of https://github.com/ycd/manage-fastapi.git synced 2021-11-08 01:34:39 +03:00
Code Issues Projects Releases Wiki Activity

📝 Update readme to match index

Browse Source
This commit is contained in:
Marcelo Trylesinski
2020-11-25 23:54:28 +01:00
parent 51115cd597
commit a7bfd24fef
2 changed files with 12 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

@@ -1,17 +1,14 @@
<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">
<img alt="Travis (.com)" src="https://img.shields.io/travis/com/ycd/manage-fastapi?style=for-the-badge">
</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/manage-fastapi" target="_blank">
<img src="https://img.shields.io/pypi/v/manage-fastapi?style=for-the-badge" alt="Package version">
@@ -21,6 +18,7 @@
</p>
---
**Documentation**: View it on [website](https://ycd.github.io/manage-fastapi/)
@@ -33,26 +31,15 @@
## Features :rocket:
## Features 🚀
* #### Creates customizable **project boilerplate.**
* #### Creates customizable **app boilerplate.**
* #### Handles the project structing for you.
* #### Handles the project structuring for you.
## Starting a new project
<img src="docs_assets/startproject.png" width=700>
## Example folder structure with two commands :open_file_folder:
```
manage-fastapi startproject fastproject
manage-fastapi startapp v1
```
## Example folder structure 📦
```
fastproject/
├── __init__.py
@@ -78,74 +65,11 @@ fastproject/
└── __init__.py
```
## Installation :pushpin:
## Installation 📌
`pip install manage-fastapi`
## Release Notes :mega:
### Latest Changes
### 0.1.60
* Delete run-server command
* Delete show-models command
* Create new template for settings without database
* Small fix for project utils
### 0.1.52
* Temporary fix for Path issue when running with uvicorn
### 0.1.51
* Little update on API template
### 0.1.5
* Added showmodels
* Added runserver
* Fix little bugs
* Update docs
### 0.1.41
* Quick fix for a little bug
### 0.1.4
* Changed project architecture
* Increased travis tests
### 0.1.3
* Make database optional
* Now Manage FastAPI has support for MongoDB, PostgreSQL, SQLite, MySQL, Tortoise ORM
### 0.1.2
* Add tests
* Fix and relocate success message
* Add travis
### 0.1.1
* Added documentation
* Fixed typos
* Additional response for successfuly creation.
### 0.1.0
* Prototype of project with two functionalities.
## License
This project is licensed under the terms of the MIT license.

4
ROADMAP.md
View File

@@ -30,6 +30,10 @@ The package plans are here. If you want to contribute with new ideas, or develop
* [ ] Add `logger` to `startproject` structure.
* [ ] Base CRUD class to `startproject`.
### Additional
* [ ] Script to copy `index.md` to `README.md` and verify if they are the same.
## Questions
* Should we support .git by default?