Skip to main content

django-df-api-drf

Project description

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
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-df-api-drf-0.0.8.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

django_df_api_drf-0.0.8-py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page