Boa (String Conversion)

1.1.0 · maintenance · verified Fri Apr 10

Boa is a Python package (version 1.1.0) designed for normalizing and converting strings to snakecase. It efficiently handles various cases, including stripping punctuation and transforming camelCase or PascalCase strings into snake_case. For example, 'User Buys Item' becomes 'user_buys_item'. The last release was in 2017, indicating that the project is no longer actively developed but remains available for its specific string conversion utility.

Warnings

gotcha The `boa-str` library has not seen updates since its 1.1.0 release on July 10, 2017. This means it may not be actively maintained for new features, bug fixes, or compatibility with newer Python versions beyond 3.6, although basic string operations are often forward-compatible.
Fix: Evaluate if the existing functionality meets your needs and be aware that community support or official updates are unlikely. Consider alternatives for actively maintained projects if this is a concern.
gotcha The name 'boa' is highly overloaded across various programming ecosystems (e.g., Boa JavaScript engine in Rust, Boa for particle accelerator analysis, Boa for Go packages, Boa for Python bridge to Node.js). Ensure you are installing and importing `boa-str` specifically for string snakecase conversion to avoid confusion with other packages.
Fix: Always use `pip install boa-str` and `import boa` as specified. Clearly delineate the purpose of this library in your project documentation.
gotcha The package's PyPI metadata lists its 'Development Status' as '4 - Beta'. This indicates it never reached a stable (5 - Production/Stable) release, implying potential for unannounced breaking changes or incomplete features, though the project has been static for many years.
Fix: Review the source code on GitHub for any hidden quirks if you encounter unexpected behavior. Given its age and simple function, it's generally stable for its stated purpose.

Install

pip install boa-str Install latest version

Imports

boa
```
import boa
```
The primary functionality is exposed directly under the 'boa' module after import.

Quickstart

The `boa.constrict()` function is the main entry point for converting strings to snakecase. It handles various input formats.

import boa

my_str_camel = 'toInfinityAndBeyond'
my_str_spaces = 'Welcome to planet Earth!'
my_str_hyphens = 'a-string-with-hyphens'

snake_camel = boa.constrict(my_str_camel)
snake_spaces = boa.constrict(my_str_spaces)
snake_hyphens = boa.constrict(my_str_hyphens)

print(f"'{my_str_camel}' -> '{snake_camel}'")
print(f"'{my_str_spaces}' -> '{snake_spaces}'")
print(f"'{my_str_hyphens}' -> '{snake_hyphens}'")

# Example of typical usage
user_event = 'User Buys Item'
processed_event = boa.constrict(user_event)
print(f"'{user_event}' -> '{processed_event}'")

view raw JSON →