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': (
'django_rest_framework_camel_case.render.CamelCaseJSONRenderer',
# Any other renders
),
'DEFAULT_PARSER_CLASSES': (
'django_rest_framework_camel_case.parser.CamelCaseJSONParser',
# Any other parsers
),
}
# ...
Swapping Renderer and Parser
By default the package uses rest_framework.renderers.JSONRenderer and rest_framework.parsers.JSONParser. If you want to use another renderer or parser, you must specify it in your django settings file.
Currently Support
'RENDERER_CLASS': (
'rest_framework.renderers.JSONRenderer',
'rest_framework.renderers.UnicodeJSONRenderer', # only available in DRF < 3.0
'rest_framework_google_json_style_api.renderers.JSONRenderer',
'rest_framework_json_api.renderers.JSONRenderer',
),
'PARSER_CLASS': (
'rest_framework.parsers.JSONParser',
'rest_framework_google_json_style_api.parsers.JSONParser',
'rest_framework_json_api.parsers.JSONParser',
)
Specify it in your django settings file.
# ...
JSON_CAMEL_CASE = {
'RENDERER_CLASS': 'rest_framework_google_json_style_api.renderers.JSONRenderer',
'PARSER_CLASS': 'rest_framework_google_json_style_api.parsers.JSONParser',
}
# ...
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
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
File details
Details for the file django-rest-framework-camel-case-2.0.1.tar.gz
.
File metadata
- Download URL: django-rest-framework-camel-case-2.0.1.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25d5da241ce15397c734edab9ff3ff6c5d7fcf58925df307432122902ac6362a |
|
MD5 | f28b1ee37c82cf2e1f2d46a833aae337 |
|
BLAKE2b-256 | 588ac674924207a51b809fad56df3dd14ce0a14e4a54c2ceac5334353100b7f5 |