Camel case JSON support for Django REST framework
Project description
Django REST Framework JSON CamelCase
Camel case JSON support for Django REST framework.
Note: This is a replacement for djangorestframework-camel-case which seems currently unmaintained.
Installation
At the command line::
$ pip install djangorestframework-camel-case2
Add the render and parser to your django settings file.
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'djangorestframework_camel_case2.render.CamelCaseJSONRenderer',
# Any other renders
),
'DEFAULT_PARSER_CLASSES': (
'djangorestframework_camel_case2.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 the project
$ python -m unittest discover
Changelog
[Unreleased]
[0.2.2]
Changed
- Update README
Removed
- Old README.rst and HISTORY.rst
[0.2.1]
Added
- Support for generators and other iterables
- JSON_UNDERSCOREIZE option to change behaviour of underscoize function
Changed
- Changed name of the package and README
[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
Hashes for djangorestframework-camel-case2-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91149ecd119631f7e9bead9ddd82e8144f8bb94a6991bbe7aefe8a96c84a18c9 |
|
MD5 | 0e5901692bf5e8a1aecfda75b051efb0 |
|
BLAKE2b-256 | 174d12792428dddeb8daac1e33e112dd92f2ee9c499d89e49e90ac21cf2948af |