pyhumps

Warnings

• gotcha Installing the wrong package: There is an older, unrelated PyPI package also named `humps`. If you install `humps` instead of `pyhumps`, you will get a different, unmaintained library. This will likely result in `AttributeError` when attempting to use functions like `camelize` or `decamelize` from the `pyhumps` API, as they won't exist in the incorrectly installed `humps` module.
  Fix: Always install the correct package using `pip install pyhumps`. If you suspect you have the wrong package, uninstall `humps` and then install `pyhumps`.
• gotcha Shadowing the `humps` module: If you create a Python file named `humps.py` in your project or name a variable `humps`, it can shadow the installed `humps` module. This will cause Python to import your local file/variable instead of the library, leading to unexpected errors or `AttributeError`s.
  Fix: Avoid naming your Python files or critical variables `humps.py` or `humps` to prevent import conflicts and ensure the correct library module is loaded.

Install

• pip install pyhumps Install with pip

Imports

• humps

  import humps

  The PyPI package name is `pyhumps`, but the module is imported as `humps`. Installing a package named `humps` (an older, unrelated project) instead of `pyhumps` will lead to an `AttributeError` when trying to use functions like `humps.camelize` from the expected library. Always ensure you install `pyhumps`.

Quickstart

This quickstart demonstrates converting strings and dictionary keys between snake_case, camelCase, PascalCase, and kebab-case. It highlights the `camelize`, `pascalize`, and `kebabize` functions for both individual strings and lists of dictionaries.

import humps

snake_case_string = "hello_world_example"
camel_case_string = humps.camelize(snake_case_string)
pascal_case_string = humps.pascalize(snake_case_string)
kebab_case_string = humps.kebabize(snake_case_string)

data = [
    {"first_name": "John", "last_name": "Doe"},
    {"first_name": "Jane", "last_name": "Smith"}
]
camelized_data = humps.camelize(data)

print(f"Original snake_case: {snake_case_string}")
print(f"Camel case: {camel_case_string}")
print(f"Pascal case: {pascal_case_string}")
print(f"Kebab case: {kebab_case_string}")
print(f"Camelized dictionary keys: {camelized_data}")