Metadata-Version: 2.4
Name: strx
Version: 0.2.12
Summary: Consistent API for string workloads
Project-URL: Documentation, https://github.com/thuyetbao/strx#README
Project-URL: Issues, https://github.com/thuyetbao/strx/issues
Project-URL: Source, https://github.com/thuyetbao/strx
Author-email: Thuyet Bao <trthuyetbao@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: python3,strx
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.12
Description-Content-Type: text/markdown

<div align="center">
  <a href="https://github.com/thuyetbao/strx.git">
    <img src="docs/assets/images/banner.png" alt="Package Banner" height="200" width="100%">
  </a>
</div>

<div align="center">
  <h3>StrX</h3>
  <p><b>Consistent API for string workloads</b></p>
</div>

<div align="center">
  <a href="https://github.com/thuyetbao/strx.git" target="_blank">
    <img src="https://img.shields.io/pypi/v/strx.svg?logo=pypi" alt="Package Version">
  </a>
</div>

<div align="center">
  <a href="https://www.python.org/" target="_blank">
    <img src="https://img.shields.io/pypi/pyversions/strx.svg?logo=python" alt="Supported Python Version">
  </a>
  <br>
  <a href="https://pre-commit.com/" target="_blank">
    <img src="https://img.shields.io/badge/pre--commit-enabled-teal?logo=pre-commit" alt="pre-commit enabled">
  </a>
  <a href="https://pre-commit.com/" target="_blank">
    <img src="https://img.shields.io/badge/pep8-enabled-teal?logo=python" alt="PEP8 enabled">
  </a>
  <a href="https://github.com/features/actions" target="_blank">
    <img src="https://img.shields.io/badge/cicd-github--action-teal?logo=github-actions" alt="Github Action">
  </a>
</div>

---

### **strx** features

- Consistent API with `str_` prefix functions

- Strict type checking: All functions use precise type hints to ensure safety and early error detection.

<!-- - Comprehensive test suite with 100% coverage and zero errors -->

### **Installation**

Install package from PyPI distribution [`strx`](https://pypi.org/project/strx/)

```bash
pip install strx
```

### **Usage**

All functions in stringr start with `str_*` and take a `string` as the first argument:

```py
import strx

# Get
strx.str_length
strx.str_sub
strx.str_to_upper
strx.str_to_lower
strx.str_trim
strx.str_reverse
strx.str_detect
strx.str_snakcase
strx.str_remove
strx.str_replace
strx.str_replace_all
strx.str_pad
strx.str_split
strx.str_count
strx.str_which
strx.str_sort
strx.str_unique
strx.str_dup
strx.str_c
strx.str_extract
strx.str_extract_all
strx.str_to_number
strx.str_to_number
```

**Documentation**:

Documentation document at folder [docs/](/docs/)

**Code Storage**:

Repository: [GitHub > Repository:`strx`](https://github.com/thuyetbao/strx)

**Releases**:

Releases: [GitHub > Repository:`strx` > Releases](https://github.com/thuyetbao/strx/releases)
