| Name | djangorestframework-versioning JSON |
| Version |
2.1.0
JSON |
| download |
| home_page | |
| Summary | Versioning tools for use with Django Rest Framework |
| upload_time | 2023-02-02 15:53:56 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2022 Robin Neville Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
rest framework
versioning
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Django REST Framework Versioning
This project aims to make it easy to support many different API versions in a Django REST Framework (DRF) project.
DRF [supports several versioning schemes](https://www.django-rest-framework.org/api-guide/versioning/) but (perhaps wisely) sidesteps the issue of how to actually deal with the different versions in your code. To quote the docs: "How you vary the API behavior is up to you".
This project provides some out-of-the box tools to handle versioning in views and serializers. The aim is to abstract away any versioning logic into a sort of "versioning layer" and allow the bulk of the code (and its developers) to focus on the latest behaviour.
## Documentation
Please see the full documentation [here](https://binnev.github.io/djangorestframework_versioning/).
## Acknowledgements
The approach taken in this project was inspired by Stripe's API version "compatibility layer", as described in blog posts by [Brandur Leach](https://stripe.com/blog/api-versioning) and [Amber Feng](https://amberonrails.com/move-fast-dont-break-your-api). I used [Ryan Kaneshiro's](https://rescale.com/blog/api-versioning-with-the-django-rest-framework/) excellent Django sketch as a starting point.
I also want to thank my colleagues at [Tranzer](https://www.tranzer.com) for encouraging me to work on this, and for being my guinea pigs / code duckies ❤️
Raw data
{
"_id": null,
"home_page": "",
"name": "djangorestframework-versioning",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "django,REST framework,versioning",
"author": "",
"author_email": "Robin Neville <robin.m.neville@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/d7/fdc646ba1c38353486e504bd39545ddb84aab5c7ca4c568e2bfb148a9993/djangorestframework_versioning-2.1.0.tar.gz",
"platform": null,
"description": "# Django REST Framework Versioning\n\nThis project aims to make it easy to support many different API versions in a Django REST Framework (DRF) project.\n\nDRF [supports several versioning schemes](https://www.django-rest-framework.org/api-guide/versioning/) but (perhaps wisely) sidesteps the issue of how to actually deal with the different versions in your code. To quote the docs: \"How you vary the API behavior is up to you\".\n\nThis project provides some out-of-the box tools to handle versioning in views and serializers. The aim is to abstract away any versioning logic into a sort of \"versioning layer\" and allow the bulk of the code (and its developers) to focus on the latest behaviour.\n\n## Documentation\n\nPlease see the full documentation [here](https://binnev.github.io/djangorestframework_versioning/).\n\n## Acknowledgements\n\nThe approach taken in this project was inspired by Stripe's API version \"compatibility layer\", as described in blog posts by [Brandur Leach](https://stripe.com/blog/api-versioning) and [Amber Feng](https://amberonrails.com/move-fast-dont-break-your-api). I used [Ryan Kaneshiro's](https://rescale.com/blog/api-versioning-with-the-django-rest-framework/) excellent Django sketch as a starting point.\n\nI also want to thank my colleagues at [Tranzer](https://www.tranzer.com) for encouraging me to work on this, and for being my guinea pigs / code duckies \u2764\ufe0f\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Robin Neville Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Versioning tools for use with Django Rest Framework",
"version": "2.1.0",
"split_keywords": [
"django",
"rest framework",
"versioning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09f9bbd02bf2ebd1dcc1c1a3fe5c41f12383910e018a406ccb4c53f83d3f3ee0",
"md5": "028be28c6fbbb1edd087d7ce5053a6cb",
"sha256": "656671e5dda2ef322988e9e748597295650414f55a9befb57a96d6ee5a5ccc91"
},
"downloads": -1,
"filename": "djangorestframework_versioning-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "028be28c6fbbb1edd087d7ce5053a6cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14716,
"upload_time": "2023-02-02T15:53:54",
"upload_time_iso_8601": "2023-02-02T15:53:54.839116Z",
"url": "https://files.pythonhosted.org/packages/09/f9/bbd02bf2ebd1dcc1c1a3fe5c41f12383910e018a406ccb4c53f83d3f3ee0/djangorestframework_versioning-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85d7fdc646ba1c38353486e504bd39545ddb84aab5c7ca4c568e2bfb148a9993",
"md5": "7aaf3d033594439279b7ec450255fad8",
"sha256": "82079a2461f53bebcd0e7f10e9888a7e0ed5ad2c089dba32810b22257f3d2bee"
},
"downloads": -1,
"filename": "djangorestframework_versioning-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7aaf3d033594439279b7ec450255fad8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9532,
"upload_time": "2023-02-02T15:53:56",
"upload_time_iso_8601": "2023-02-02T15:53:56.382389Z",
"url": "https://files.pythonhosted.org/packages/85/d7/fdc646ba1c38353486e504bd39545ddb84aab5c7ca4c568e2bfb148a9993/djangorestframework_versioning-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-02 15:53:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "djangorestframework-versioning"
}
