Metadata-Version: 2.1
Name: decancer_py
Version: 0.2.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
License-File: LICENSE
Summary: Python bindings for decancer.
Keywords: decancer,ffi,string,parsing,unicode
Home-Page: https://github.com/Jonxslays/decancer_py
Author: Jonxslays
License: MIT
Requires-Python: >=3.7,<3.12
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: homepage, https://github.com/Jonxslays/decancer_py
Project-URL: documentation, https://github.com/Jonxslays/decancer_py
Project-URL: repository, https://github.com/Jonxslays/decancer_py

# decancer_py

Python bindings for [decancer](https://github.com/null8626/decancer).

## Installation

You can get started with `decancer_py` by installing from PyPI:

```bash
pip install -U decancer-py
```

## Usage

`decancer_py` can be used to turn sketchy text strings into their more
basic counterparts.

Only one function is exported from `decancer_py`:

- `parse` - Parse a jank string to a normal string wrapped in a `CuredString` object.

```py
from decancer_py import parse, CuredString

parsed: CuredString = parse("𝔂ＥＥ𝓣")

assert "ee" in parsed
assert parsed == "yeet"
assert parsed.contains("ee")
assert parsed.ends_with("et")
assert parsed.starts_with("ye")

# Implicit string conversion
print(parsed_as_str)
# yeet
```

## License

`decancer_py` is licensed under the
[MIT License](https://github.com/Jonxslays/decancer_py/blob/master/LICENSE).

