- Fully documented and with examples! (html version on [readthedocs.io](https://python-string-utils.readthedocs.io/en/develop))

- 100% code coverage! (see it with your own eyes on [codecov.io](https://codecov.io/gh/daveoncode/python-string-utils/branch/develop))

- Tested (automatically on each push thanks to Travis CI) against all officially supported Python versions: 3.5, 3.6, 3.7, 3.8.

Python String Utils: Overview

This is a handy library to validate, manipulate and generate strings, which is:

- Simple and "pythonic"

- Fully documented and with examples!

- 100% code coverage!

- Tested against all officially supported Python versions: 3.5, 3.6, 3.7, 3.8.

- Fast (mostly based on compiled regex)

- Free from external dependencies

- PEP8 complaint

Library structure

The library basically consists in the python package `string_utils`, containing the following modules:

- `validation.py` (contains string check api)

- `manipulation.py` (contains string transformation api)

- `generation.py` (contains string generation api)

- `errors.py` (contains library-specific errors)

- `_regex.py` (contains compiled regex **FOR INTERNAL USAGE ONLY**)

Plus a secondary package `tests` which includes several submodules.

Specifically one for each test suite and named according to the api to test (eg. tests for `is_ip()`

will be in `test_is_ip.py` and so on).

All the public API are importable directly from the main package `string_utils`, so this:

>>> from string_utils.validation import is_ip

can be simplified as:

>>> from string_utils import is_ip