drfrequests 0.5

Document Web APIs made with Django Rest Framework.

drfrequests

Django Rest Framework Requests

Documentation

Installation

Install using pip:

pip install drfrequests

Add 'rest_framework_docs' to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...
    'rest_framework_requests',
]

Finally include the rest_framework_docs urls in your urls.py:

urlpatterns = [
    ...
    path('docs/', include('rest_framework_requests.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

packaging: Update Version

Updating your distribution Down the road, after you’ve made updates to your distribution and wish to make a new release:

pip install build
pip install twine

• increment the version number in your setup.cfg file
• $ python3 -m build

Upload package to the Python Package Index:

$ twine upload dist/*

see: https://packaging.python.org/tutorials/packaging-projects/

For development

pip install -e ../drfrequests/