Camel case JSON support for Django REST framework.
Project description
Django REST Framework JSON CamelCase
Camel case JSON support for Django REST framework.
Installation
At the command line:
$ pip install djangorestframework-camel-case
Add the render and parser to your django settings file.
# ...
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'djangorestframework_camel_case.render.CamelCaseJSONRenderer',
'djangorestframework_camel_case.render.CamelCaseBrowsableAPIRenderer',
# Any other renders
),
'DEFAULT_PARSER_CLASSES': (
# If you use MultiPartFormParser or FormParser, we also have a camel case version
'djangorestframework_camel_case.parser.CamelCaseFormParser',
'djangorestframework_camel_case.parser.CamelCaseMultiPartParser',
'djangorestframework_camel_case.parser.CamelCaseJSONParser',
# Any other parsers
),
}
# ...
Swapping Renderer
By default the package uses rest_framework.renderers.JSONRenderer. If you want to use another renderer (the only possible alternative is rest_framework.renderers.UnicodeJSONRenderer, only available in DRF < 3.0), you must specify it in your django settings file.
# ...
JSON_CAMEL_CASE = {
'RENDERER_CLASS': 'rest_framework.renderers.UnicodeJSONRenderer'
}
# ...
Underscoreize Options
As raised in https://github.com/krasa/StringManipulation/issues/8#issuecomment-121203018 there are two conventions of snake case.
# Case 1 (Package default)
v2Counter -> v_2_counter
fooBar2 -> foo_bar_2
# Case 2
v2Counter -> v2_counter
fooBar2 -> foo_bar2
By default, the package uses the first case. To use the second case, specify it in your django settings file.
REST_FRAMEWORK = {
# ...
'JSON_UNDERSCOREIZE': {
'no_underscore_before_number': True,
},
# ...
}
Running Tests
To run the current test suite, execute the following from the root of he project:
$ python -m unittest discover
License
Free software: BSD license
History
1.1.0 (2019-09-09)
Long awaited stable release:
Changes can be viewed: https://github.com/vbabiy/djangorestframework-camel-case/compare/e6db468…39ae6bb
0.1.0 (2013-12-20)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for djangorestframework-camel-case-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a9403c44d14f0d1352f3bbce3a7d0ba71abd1d3bf2aaa8a03afef600cee511d |
|
MD5 | aef24b6883c7b6ed0596517a31237dfb |
|
BLAKE2b-256 | dc6d8b76e80b825f03bde31dad2ea4d6c6ee0d2e608c8b2e6c0416e291a24238 |
Hashes for djangorestframework_camel_case-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e95f057cc9738f8715617b111639ca13a3c20de6e80f201a999184eaa9314aa |
|
MD5 | 99dc9449fe8b446348f88e9422155ce1 |
|
BLAKE2b-256 | 76241e6bac6ea6ba3ff4ad40134d16a0658b63974ca44f4e3061a349fa3f8468 |