2022-03-21 18:00:20 +01:00
|
|
|
GAS-DRF
|
|
|
|
|
=======
|
2022-03-21 17:48:13 +01:00
|
|
|
|
|
|
|
|
[DRF](https://www.django-rest-framework.org/) support for [django-gas](https://pypi.org/project/django-gas/).
|
|
|
|
|
|
|
|
|
|
Helps working with an API restricted to gas roles.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Instalation
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
1. Install `django-gas-drf` package:
|
|
|
|
|
|
|
|
|
|
pip install django-gas-drf
|
|
|
|
|
|
|
|
|
|
3. Add `gas-drf` urls to project's `urls.py`:
|
|
|
|
|
|
|
|
|
|
import gas_drf.sites
|
|
|
|
|
|
|
|
|
|
urlpatterns = [
|
|
|
|
|
path('control-panel-api/', include(gas_drf.sites.site.urls)),
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Integration
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
Create a submodule `gas.drf_config` in your django app.
|
|
|
|
|
|
|
|
|
|
-\ yourapp
|
|
|
|
|
\gas
|
|
|
|
|
__init__.py
|
|
|
|
|
drf_config.py
|
|
|
|
|
admin.py
|
|
|
|
|
models.py
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
Edit this `drf_config.py` file to register your code into `gas-drf`. For
|
|
|
|
|
examples look at `drf_gas.gas.users_drf_config` module.
|
|
|
|
|
|
|
|
|
|
Gas DRF comes with basic user management. To enable this import
|
|
|
|
|
`gas_drf.gas.users_drf_config` from any `gas.drf_config` of your installed
|
|
|
|
|
apps.
|
|
|
|
|
|
|
|
|
|
Licenses
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
The license of the code is GPLv3.
|
