Django REST Framework extensions
DRF-extensions is a collection of custom extensions for Django REST Framework
Full documentation for project is available at http://chibisov.github.io/drf-extensions/docs
Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.
- Tested for Python 3.6, 3.7 and 3.8
- Tested for Django Rest Framework 3.12
- Tested for Django 2.2 to 3.2
- Tested for django-filter 2.1.0
pip3 install drf-extensions or from github pip3 install https://github.com/chibisov/drf-extensions/archive/master.zip
- Conditional requests
- Customizable key construction for caching and conditional requests
- Nested routes
- Bulk operations
Read more in documentation
Running the tests:
$ pip3 install tox $ tox -- tests_app
Running test for exact environment:
$ tox -e py38 -- tests_app
Recreate envs before running tests:
$ tox --recreate -- tests_app
Pass custom arguments:
$ tox -- tests_app --verbosity=3
Run with pdb support:
$ tox -- tests_app --processes=0 --nocapture
Run exact TestCase:
$ tox -- tests_app.tests.unit.mixins.tests:DetailSerializerMixinTest_serializer_detail_class
Run tests from exact module:
$ tox -- tests_app.tests.unit.mixins.tests
$ make build_docs
Automatically build docs by watching changes:
$ pip install watchdog $ make watch_docs
Developing new features
Every new feature should be:
- Pushed to main repository
How to write documentation
When new feature implementation starts you should place it into
development version pull. Add
Release notes and describe every new feature in it. Use
#anchors to facilitate navigation.
Every feature should have title and information that it was implemented in current development version.
For example if we've just implemented
Usage of the specific cache:
... #### Usage of the specific cache *New in DRF-extensions development version* `@cache_response` can also take... ... ### Release notes ... #### Development version * Added ability to [use a specific cache](#usage-of-the-specific-cache) for `@cache_response` decorator
Publishing new releases
Increment version in
rest_framework_extensions/__init__.py. For example:
__version__ = '0.2.2' # from 0.2.1
Move to new version section all release notes in documentation.
Add date for release note section.
Replace in documentation all
New in DRF-extensions development version notes to
New in DRF-extensions 0.2.2.
Commit changes with message "Version 0.2.2"
Add new tag version for commit:
$ git tag 0.2.2
Push to master with tags:
$ git push origin master --tags
Don't forget to merge
gh-pages branch and push to origin:
$ git co gh-pages $ git merge --no-ff master $ git push origin gh-pages
Publish to pypi:
$ python setup.py publish
Thank you to all our backers!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]