Skip to content

Commit aadce17

Browse files
committed
Merge branch 'develop' of github.com:LuisLuii/FastAPIQuickCRUD into develop
* 'develop' of github.com:LuisLuii/FastAPIQuickCRUD: Update README.md Update README.md Update README.md Delete .idea directory no message Delete sample_test.py Update README.md update readme update gitgnore
2 parents e83c7ad + 272f5f4 commit aadce17

File tree

4 files changed

+11
-74
lines changed

4 files changed

+11
-74
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ PKG-INFO
1616
fastapi_quickcrud_code_generator_beta.egg-info
1717
src/fastapi_quickcrud.egg-info
1818
dist
19+
*.gz
20+
*.txt
21+
*.
22+
PKG-INFO

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c2a6306f7f0a41948369d80368eb7abb?style=flat-square)](https://www.codacy.com/gh/LuisLuii/FastAPIQuickCRUD/dashboard?utm_source=github.com&utm_medium=referral&utm_content=LuisLuii/FastAPIQuickCRUD&utm_campaign=Badge_Grade)
66
[![Coverage Status](https://coveralls.io/repos/github/LuisLuii/FastAPIQuickCRUD/badge.svg?branch=main)](https://coveralls.io/github/LuisLuii/FastAPIQuickCRUD?branch=main)
77
[![CircleCI](https://circleci.com/gh/LuisLuii/FastAPIQuickCRUD/tree/main.svg?style=svg)](https://circleci.com/gh/LuisLuii/FastAPIQuickCRUD/tree/main)
8-
[![Downloads](https://static.pepy.tech/personalized-badge/fastapi-quickcrud?period=week&units=none&left_color=black&right_color=orange&left_text=Week%20Downloads%20)](https://pepy.tech/project/fastapi-quickcrud)
98
[![SupportedVersion](https://img.shields.io/pypi/pyversions/fastapi-quickcrud?style=flat-square)](https://pypi.org/project/fastapi-quickcrud)
109
[![develop dtatus](https://img.shields.io/pypi/status/fastapi-quickcrud?style=flat-square)](https://pypi.org/project/fastapi-quickcrud)
1110
[![PyPI version](https://badge.fury.io/py/fastapi-quickcrud.svg)](https://badge.fury.io/py/fastapi-quickcrud)
@@ -16,7 +15,6 @@
1615

1716
![intro](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/pic/example.gif)
1817

19-
![intro2](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/pic/foreign_tree.gif)
2018

2119

2220

@@ -62,8 +60,8 @@ I believe that many people who work with FastApi to build RESTful CRUD services
6260
`FastAPI Quick CRUD`is developed based on SQLAlchemy `1.4.23` version and supports sync and async.
6361

6462
![docs page](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/pic/page_preview.png?raw=true)
63+
![docs_page_2](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/pic/foreign_tree.png?raw=true)
6564

66-
## [Developing](https://github.com/LuisLuii/FastAPIQuickCRUD/issues/9)
6765

6866

6967
## Advantages
@@ -117,7 +115,7 @@ pip install asyncpg
117115
```
118116

119117
## Usage
120-
118+
run and go to http://127.0.0.1:port/docs and see the auto-generated API
121119
### Simple Code (or see the longer ([example](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/tutorial/sample.py))
122120

123121

@@ -348,6 +346,9 @@ uvicorn.run(app, host="0.0.0.0", port=8000, debug=False)
348346
- exclude_columns: `list`
349347
> set the columns that not to be operated but the columns should nullable or set the default value)
350348

349+
- foreign_include: `list[declarative_base()]`
350+
> add the SqlAlchemy models here, and build the foreign tree get one/many api (don't support SqlAlchemy table)
351+
351352

352353
- dynamic argument (prefix, tags): extra argument for APIRouter() of fastapi
353354

@@ -699,7 +700,7 @@ If there are no users in the system, then, in this case, you should return 204.
699700

700701

701702
### TODO
703+
[milestones](https://github.com/LuisLuii/FastAPIQuickCRUD/milestones)
702704

703-
- Upsert operation for each SQL
704705

705706

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from setuptools import setup, find_packages
22

3-
VERSION = '0.2.1'
3+
VERSION = '0.2.2'
44

55
print("""
66

src/fastapi_quickcrud/sample_test.py

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)