Skip to main content

Document Web APIs made with Django Rest Framework.

Project description

drfrequests

Django Rest Framework Requests

Installation

Install using pip:

pip install drfrequests

Add 'rest_framework_docs' to your INSTALLED_APPS setting:

INSTALLED_APPS = (
    ...
    'rest_framework_docs',
)

Finally include the rest_framework_docs urls in your urls.py:

urlpatterns = [
    ...
    url(r'^docs/', include('rest_framework_docs.urls')),
]

Settings

You can find detailed information about the package's settings at the docs.

REST_FRAMEWORK_DOCS = {
    'HIDE_DOCS': True  # Default: False
}

Credits

This project is a frok of https://github.com/manosim/django-rest-framework-docs which is a fork of https://github.com/marcgibbons/django-rest-framework-docs

Test Build

  • increment the version number in your setup.cfg file
  • $ python3 -m build
  • First upload to TestPypi: twine upload --repository testpypi dist/*
  • install pip install --index-url https://test.pypi.org/simple/ --no-deps drfrequests

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

drfrequests-0.1.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

drfrequests-0.1-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

Details for the file drfrequests-0.1.tar.gz.

File metadata

  • Download URL: drfrequests-0.1.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for drfrequests-0.1.tar.gz
Algorithm Hash digest
SHA256 449572d7132a3bc624886d22fb83af6b56c1d4e376d5a47044a677c6cd977f1e
MD5 8d1b593f3f001ea87b4ac9dac3da29bd
BLAKE2b-256 ae1e06184d935d4662628a6bb44fc8d2962173cf6de989e633fc4f5666eafcab

See more details on using hashes here.

File details

Details for the file drfrequests-0.1-py3-none-any.whl.

File metadata

  • Download URL: drfrequests-0.1-py3-none-any.whl
  • Upload date:
  • Size: 26.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for drfrequests-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df00a12615331c20a47223aeea608e861bc6eb645955a21cbff490342b0da2a0
MD5 df47f217ed031d1872ed1e527d2ff794
BLAKE2b-256 45e7d6a1e41765c94043f25bd3bd18096ae30fac3d82fa0a65c636184062b551

See more details on using hashes here.

Supported by

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