Metadata-Version: 2.4
Name: profanite
Version: 0.1.9
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Rust
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Topic :: Text Processing :: Filters
Classifier: Topic :: Internet :: WWW/HTTP :: Session
Summary: Kryptonite for profanities — lightweight, obfuscation-resistant profanity filter
License: GPL-3.0-or-later
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Repository, https://github.com/Beatsphere/profanite

# profanite (Python)

Python bindings for [profanite](https://github.com/Beatsphere/profanite) — a lightweight, obfuscation-resistant profanity filter.

## Install

Until v0.1 ships to PyPI, build locally:

```bash
pip install maturin
cd crates/profanite-py
maturin develop --release
```

## Usage

```python
from profanite import Profanite

p = Profanite({"languages": ["en"]})

p.contains_profanity("what the fuck")   # True
p.censor("what the fuck")               # "what the ****"
hits = p.find("oh fuck that")
hits[0].start, hits[0].end               # (3, 7)
```

See the top-level README for the full configuration reference.

