Skip to main content

Django REST Framework JSON CamelCase

https://travis-ci.org/vbabiy/djangorestframework-camel-case.png?branch=master https://badge.fury.io/py/djangorestframework-camel-case.svg

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.

Metadata

Release files for django-rest-framework-camel-case 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-rest-framework-camel-case 2.0.1
File Size Uploaded Provenance Actions
django-rest-framework-camel-case-2.0.1.tar.gz 5.1 kB Without provenance Details for django-rest-framework-camel-case-2.0.1.tar.gz

Release files / django-rest-framework-camel-case-2.0.1.tar.gz

Download URL django-rest-framework-camel-case-2.0.1.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
25d5da241ce15397c734edab9ff3ff6c5d7fcf58925df307432122902ac6362a
BLAKE2b-256 checksum
How to use checksums
588ac674924207a51b809fad56df3dd14ce0a14e4a54c2ceac5334353100b7f5
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for django-rest-framework-camel-case 2.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page