Skip to main content

Camel Converter

Test Status Coverage PyPI version PyPI - Python Version

In JSON keys are frequently in camelCase format, while variable names in Python are typically snake_case. The purpose of this package is to help convert between the two formats.

Usage

  • To convert from camel case to snake case:

    from camel_converter import to_snake
    
    snake = to_snake("myString")
    

    This will convert myString into my_string

  • To convert a dictionary's keys from camel case to snake case:

    from camel_converter import dict_to_snake
    
    snake = dict_to_snake({"myString": "val 1"})
    

    This will convert {"myString": "val 1"} into {"my_string": "val 1"}. Non-string keys will be left unchanged.

    This is also available as a decorator for functions that return a dictionary.

    from camel_converter.decorators import dict_to_snake
    
    
    @dict_to_snake
    def my_func() -> dict[str, str]:
        return {"myString": "val 1"}
    
    
    snake = my_func()
    

    my_func will return {"my_string": "val 1"}. Non-string keys will be left unchanged.

  • To convert from snake case to camel case:

    from camel_converter import to_camel
    
    camel = to_camel("my_string")
    

    This will convert my_string into myString

  • To convert from a dictionary's keys from snake case to camel case:

    from camel_converter import dict_to_camel
    
    camel = dict_to_camel({"my_string": "val 1"})
    

    This will convert {"my_string": "val 1"} into {"myString": "val 1"} Non-string keys will be left unchanged.

    This is also available as a decorator for functions that return a dictionary.

    from camel_converter.decorators import dict_to_camel
    
    
    @dict_to_camel
    def my_func() -> dict[str, str]:
        return {"my_string": "val 1"}
    
    
    camel = my_func()
    

    my_func will return {"myString": "val 1"}. Non-string keys will be left unchanged.

  • To convert from snake to pascal case:

    from camel_converter import to_pascal
    
    pascal = to_pascal("my_string")
    

    This will convert my_string into MyString

  • To convert from a dictionary's keys from snake case to pascal case:

    from camel_converter import dict_to_pascal
    
    pascal = dict_to_pascal({"my_string": "val 1"})
    

    This will convert {"my_string": "val 1"} into {"MyString": "val 1"} Non-string keys will be left unchanged.

    This is also available as a decorator for functions that return a dictionary.

    from camel_converter.decorators import dict_to_pascal
    
    
    @dict_to_pascal
    def my_func() -> dict[str, str]:
        return {"my_string": "val 1"}
    
    
    pascal = my_func()
    

    my_func will return {"MyString": "val 1"}. Non-string keys will be left unchanged.

  • Class base model to add methods

Inheriting the Converter adds to_camel and from_camel methods to your class

from camel_converter import Converter


class SomeClass(Converter):
    some_value = "some value"

    def __init__(self) -> None:
        self.another_value = "another value"


example = SomeClass()
print(example.to_camel())

This will print {"someValue": "some value", "anotherValue": "another value"}

from camel_converter import Converter


class SomeClass(Converter):
    def __init__(self, some_value: str) -> None:
        self.some_value = some_value


example = SomeClass.from_camel({"someValue": "some value"})
print(example.some_value)

This will print some value

Optional Extras

An optional extra is provided for Pydantic that provides a base class to automatically convert between snake case and camel case. To use this Pydantic class install camel converter with:

pip install camel-converter[pydantic]

Then your Pydantic classes can inherit from CamelBase.

from camel_converter.pydantic_base import CamelBase


class MyModel(CamelBase):
    test_field: str


my_data = MyModel(**{"testField": "my value"})
print(my_data.test_field)

will result in my value being printed.

With setting up your model in this way myField from the source, i.e. JSON data, will map to my_field in your model.

Contributing

If you are interested in contributing to this project please see our contributing guide

Metadata

Release files for camel-converter 6.0.2

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

Source distribution (sdist)

Source distribution for camel-converter 6.0.2
File Size Uploaded Provenance Actions
camel_converter-6.0.2.tar.gz 47.8 kB Without provenance Details for camel_converter-6.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for camel-converter 6.0.2
File Interpreter ABI Platform Actions
camel_converter-6.0.2-py3-none-any.whl Python 3 none any Details for camel_converter-6.0.2-py3-none-any.whl

Total release size: 55.2 kB

Release files / camel_converter-6.0.2.tar.gz

Download URL camel_converter-6.0.2.tar.gz
Size 47.8 kB
Tags Source
SHA-256 checksum
How to use checksums
db59a70a2dbc86edf21f2853b393346c54b2810d5b4d9f718cf17e9aede7f04f
BLAKE2b-256 checksum
How to use checksums
75c96e9250164d46c4ee6e6e31676f43b89ffc7a582ed2b40b5dc760058287dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / camel_converter-6.0.2-py3-none-any.whl

Download URL camel_converter-6.0.2-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d4f777c6cad8e925c3480ff4751d1fffd660e9db557e7ac568f1f59b71d3cf81
BLAKE2b-256 checksum
How to use checksums
c1fc53c5c2b61ec99daccce9d1b7a1490d19d555153f349078ee2a1f4809440f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for camel-converter 6.0.2

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

6.0.2 This release

2 release files 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