{"id":13813873,"url":"https://github.com/manosim/django-rest-framework-docs","last_synced_at":"2025-04-13T05:04:05.749Z","repository":{"id":65243469,"uuid":"47850057","full_name":"manosim/django-rest-framework-docs","owner":"manosim","description":"Document Web APIs made with Django Rest Framework","archived":false,"fork":false,"pushed_at":"2022-01-11T09:27:44.000Z","size":4833,"stargazers_count":646,"open_issues_count":71,"forks_count":184,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-13T05:03:24.277Z","etag":null,"topics":["django","django-rest-framework","docs","pypi","web-api"],"latest_commit_sha":null,"homepage":"https://www.drfdocs.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manosim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-11T20:44:14.000Z","updated_at":"2025-04-01T21:27:31.000Z","dependencies_parsed_at":"2023-01-16T20:45:13.852Z","dependency_job_id":null,"html_url":"https://github.com/manosim/django-rest-framework-docs","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manosim%2Fdjango-rest-framework-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manosim%2Fdjango-rest-framework-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manosim%2Fdjango-rest-framework-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manosim%2Fdjango-rest-framework-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manosim","download_url":"https://codeload.github.com/manosim/django-rest-framework-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665748,"owners_count":21142123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","django-rest-framework","docs","pypi","web-api"],"created_at":"2024-08-04T04:01:34.056Z","updated_at":"2025-04-13T05:04:05.717Z","avatar_url":"https://github.com/manosim.png","language":"Python","funding_links":[],"categories":["RESTful API","Python"],"sub_categories":[],"readme":"# [DRF Docs](http://www.drfdocs.com/) [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url] [![slack][slack-image]][slack-url]\n\nDocument Web APIs made with Django Rest Framework. [View Demo](http://demo.drfdocs.com/)\n\n\u003e **Contributors Wanted**: Do you like this project? Using it? Let's make it better!\n\n![DRFdocs](https://cloud.githubusercontent.com/assets/6333409/13193861/69e82aec-d778-11e5-95c4-77f4ef29e6e5.png)\n\n### Supports\n\n  - Python (2.7, 3.3, 3.4, 3.5)\n  - Django (1.8, 1.9)\n  - Django Rest Framework (3+)\n\n\n### Documentation - Table of contents\n\n  - [Installation](http://drfdocs.com/installation/)\n  - [Settings](http://drfdocs.com/settings/)\n  - [Extending the template](http://drfdocs.com/templates/)\n  - [Live API Endpoints](http://drfdocs.com/live-api/)\n  - [Contributing \u0026 Development](http://drfdocs.com/contributing/)\n  - [Changelog](http://drfdocs.com/changelog/)\n\n\n### Development \u0026 Demo Project\nIf you are looking to develop this package with one of your own django projects:\n\n    pyvenv env\n    env/bin/pip install -r requirements.txt\n    pip install -e ~/Projects/drf-docs/\n\nIf you want to use the demo app to work on this package:\nIncluded in this repo you can find the demo project(at `/demo`). It is a project with *Django* \u0026 *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.\n\nFor more information visit [the docs](http://drfdocs.com/contributing/).\n\n### Installation\n\nInstall using pip:\n\n    pip install drfdocs\n\nAdd 'rest_framework_docs' to your `INSTALLED_APPS` setting:\n\n    INSTALLED_APPS = (\n        ...\n        'rest_framework_docs',\n    )\n\nFinally include the `rest_framework_docs` urls in your `urls.py`:\n\n    urlpatterns = [\n        ...\n        url(r'^docs/', include('rest_framework_docs.urls')),\n    ]\n\n\n### Settings\nYou can find detailed information about the package's settings at [the docs](http://drfdocs.com/settings/).\n\n    REST_FRAMEWORK_DOCS = {\n        'HIDE_DOCS': True  # Default: False\n    }\n\n\n### Credits\n\nFirst of all thanks to the [Django](http://www.djangoproject.com/) core team and to all the contributors of [Django REST Framework](http://www.django-rest-framework.org/) for their amazing work. Also I would like to thank [Marc Gibbons](https://github.com/marcgibbons) for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ \u0026 Python 3.\n\n[travis-image]: https://travis-ci.org/manosim/django-rest-framework-docs.svg?branch=master\n[travis-url]: https://travis-ci.org/manosim/django-rest-framework-docs\n\n[pypi-image]: https://badge.fury.io/py/drfdocs.svg\n[pypi-url]: https://pypi.python.org/pypi/drfdocs/\n\n[codecov-image]: https://codecov.io/github/manosim/django-rest-framework-docs/coverage.svg?branch=master\n[codecov-url]:https://codecov.io/github/manosim/django-rest-framework-docs?branch=master\n\n[slack-image]: https://img.shields.io/badge/slack-pythondev/drfdocs-e01563.svg\n[slack-url]: https://pythondev.slack.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanosim%2Fdjango-rest-framework-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanosim%2Fdjango-rest-framework-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanosim%2Fdjango-rest-framework-docs/lists"}