Metadata-Version: 2.1
Name: django-admin-api
Version: 0.0.3
Summary: export Django Admin API by restful style
Home-page: https://github.com/django-extend/django-admin-api.git
Author: Nieo Ding
Author-email: 8285770@qq.com
License: BSD License
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
Requires-Dist: djangorestframework
Requires-Dist: django-filter
Requires-Dist: pyjwt

English | [简体中文](./README.zh-CN.md)

----

# Requirements

* Python (3.5, 3.6, 3.7, 3.8, 3.9)
* Django (2.2, 3.0, 3.1, 3.2)

# Step 1: Installation

Install using `pip`...

    pip install django-admin-api

Add  to your `INSTALLED_APPS` setting as followed.

    INSTALLED_APPS = [
        ...
        'rest_framework',
        'django_filters',
        'admin_api',
    ]

# Step 2: Startup up a demo project

Startup up a new project like so...

    django-admin startproject example
    cd example
    ./manage.py migrate
    ./manage.py createsuperuser

# Step 3: export API with 'api' end-point

```python
# example/urls.py
...
import admin_api
urlpatterns = [
  ...
  path('api/', admin_api.site.urls),
]
```

# Frontend framework

framework | project
---|---
ant-design(vue) | [antd-django](https://github.com/django-extend/antd-django.git)

# helper links

helper | link
---|---
api detail | [document](api.md)



