Metadata-Version: 2.1
Name: django-df-api-drf
Version: 1.0.0
Summary: django-df-api-drf
Author-email: Apexive OSS <open-source@apexive.com>
License: MIT License
        
        Copyright (c) 2023 Apexive.com
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://apexive.com/
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# Django DF API DRF

Module for automatic including Djangoflow apps API to your project.

## Installation:

- Install the package

```
pip install django-df-api-drf
```


- Include default settings from `df_api_drf.defaults` to your `settings.py`

```python
from df_api_drf.defaults import DF_API_DRF_INSTALLED_APPS, REST_FRAMEWORK, SPECTACULAR_SETTINGS

INSTALLED_APPS = [
    ...
    *DF_API_DRF_INSTALLED_APPS,
    ...
]

REST_FRAMEWORK = {
    ...
    **REST_FRAMEWORK,
}

SPECTACULAR_SETTINGS = {
    ...
    **SPECTACULAR_SETTINGS,
}
```


- Alternatively, you can include the package to your `INSTALLED_APPS` manually and set up `REST_FRAMEWORK` and `SPECTACULAR_SETTINGS` by yourself:

```
INSTALLED_APPS = [
    ...
    'df_api_drf',
    ...
]

REST_FRAMEWORK = {
    ...
}

SPECTACULAR_SETTINGS = {
    ...
}
```


- Add the package to your urls.py

```
urlpatterns = [
    ...
    path("api/", include("df_api_drf.urls")),
    ...
]
```

## Development

Installing dev requirements:

```
pip install -e .[test]
```

Installing pre-commit hook:

```
pre-commit install
```

Running tests:

```
pytest
```
