Skip to content

Commit 39b96b6

Browse files
authored
Update README.md
1 parent b708ad2 commit 39b96b6

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
![Test](https://github.com/freemindcore/django-api-framework/actions/workflows/test_full.yml/badge.svg)
21
[![PyPI version](https://badge.fury.io/py/django-api-framework.svg)](https://badge.fury.io/py/django-api-framework)
32
[![PyPI version](https://img.shields.io/pypi/v/django-api-framework.svg)](https://pypi.python.org/pypi/django-api-framework)
4-
[![PyPI version](https://img.shields.io/pypi/pyversions/django-api-framework.svg)](https://pypi.python.org/pypi/django-api-framework)
5-
[![PyPI version](https://img.shields.io/pypi/djversions/django-api-framework.svg)](https://pypi.python.org/pypi/django-api-framework)
3+
4+
![Test](https://github.com/freemindcore/django-api-framework/actions/workflows/test_full.yml/badge.svg)
65
[![Codecov](https://img.shields.io/codecov/c/gh/freemindcore/django-api-framework)](https://codecov.io/gh/freemindcore/django-api-framework)
76
[![Downloads](https://pepy.tech/badge/django-api-framework/month)](https://pepy.tech/project/django-api-framework)
87

9-
# Django Easy API Framework
8+
[![PyPI version](https://img.shields.io/pypi/pyversions/django-api-framework.svg)](https://pypi.python.org/pypi/django-api-framework)
9+
[![PyPI version](https://img.shields.io/pypi/djversions/django-api-framework.svg)](https://pypi.python.org/pypi/django-api-framework)
10+
1011

11-
### Easy and Fast Django REST framework based on Django-Ninja-Extra
12+
# Easy CRUD API Framework
1213

1314
- Zero code for a full CRUD API: Automatic and configurable, inspired by [NextJs-Crud](https://github.com/nestjsx/crud).
1415
- Async CRUD API with Django RBAC security protection
1516
- Prefetch and retrieve all m2m fields if configured
1617
- Recursively retrieve all FK/OneToOne fields if configured
1718
- Excluding fields you do not want, or define a list of sensitive fields of your choice
19+
- Pure class based [Django-Ninja](https://github.com/vitalik/django-ninja) APIs: thanks to [Django-Ninja-Extra](https://github.com/eadwinCode/django-ninja-extra)
1820
- Domain/Service/Controller Base Structure: for better code organization.
1921
- Base Permission/Response/Exception Classes: and some handy features to help your API coding easier.
20-
- Pure class based [Django-Ninja](https://github.com/vitalik/django-ninja) APIs: thanks to [Django-Ninja-Extra](https://github.com/eadwinCode/django-ninja-extra)
2122

2223
```
2324
Django-Ninja features:
@@ -34,13 +35,7 @@ Plus Extra:
3435
Dependency Injection: Controller classes supports dependency injection with python Injector or django_injector. Giving you the ability to inject API dependable services to APIController class and utilizing them where needed
3536
```
3637

37-
### Requirements
38-
- Python >= 3.6
39-
- Django >= 3.1
40-
- pydantic >= 1.6
41-
- Django-Ninja-Extra >= 0.15.0
42-
43-
### Install
38+
## Install
4439
`pip install django-api-framework`
4540

4641
Then add "easy" to your django INSTALLED_APPS:
@@ -53,8 +48,8 @@ Then add "easy" to your django INSTALLED_APPS:
5348
]
5449
```
5550

56-
### Usage
57-
#### Get all your Django app CRUD APIs up and running in < 1 min
51+
## Usage
52+
### Get all your Django app CRUD APIs up and running in < 1 min
5853
In your Django project next to urls.py create new apis.py file:
5954
```
6055
from easy.main import EasyAPI
@@ -90,7 +85,14 @@ https://github.com/freemindcore/django-easy-api
9085
![Auto generated APIs - Users](https://github.com/freemindcore/django-api-framework/blob/9aa26e92b6fd79f4d9db422ec450fe62d4cd97b9/docs/images/user_admin_api.png)
9186

9287

93-
### More Configuration
88+
## Thanks to your help
89+
**_If you find this project useful, please give your stars to support this open-source project. :) Thank you !_**
90+
91+
92+
93+
94+
95+
## Advanced Usage
9496
If `CRUD_API_ENABLED_ALL_APPS` is set to True (default), all app models CRUD apis will be generated.
9597
Apps in the `CRUD_API_EXCLUDE_APPS` list, will always be excluded.
9698

@@ -140,7 +142,3 @@ class EventAPIController(CrudAPIController):
140142
141143
```
142144
Please check tests/demo_app for more examples.
143-
144-
145-
### Thanks to your help
146-
**_If you find this project useful, please give your stars to support this open-source project. :) Thank you !_**

0 commit comments

Comments
 (0)