# pygarble

> pygarble is a local Python library for PII detection, secret scanning, profanity detection, gibberish checks and redaction. No LLM calls.

These are current-source docs; consult installation and migration before assuming an API is in a published PyPI version.
Use pygarble.screening for PII, secrets and profanity; pygarble.gibberish for gibberish. The top-level Scanner keeps all four categories. Scores are heuristics, not probabilities.

## Documentation

- [API Reference](https://brightertiger.github.io/pygarble/api.html): Python API reference for pygarble screening, optional backends, gibberish detection, calibration and result types.
- [Module layout and compatibility](https://brightertiger.github.io/pygarble/architecture.html): Explore pygarble's screening and gibberish modules, shared data, lazy loading and compatibility pointers.
- [Benchmark and preprint](https://brightertiger.github.io/pygarble/benchmarks.html): pygarble's preprint benchmark on survey junk and tweets against two CPU baselines. Results, intervals, cost and reproduction.
- [Calibrating the threshold](https://brightertiger.github.io/pygarble/calibration.html): Choose a gibberish threshold using labelled examples and pygarble's precision, recall and false-positive-rate reports.
- [Command-line interface](https://brightertiger.github.io/pygarble/cli.html): Scan or redact documents with pygarble-screen, or run line-based gibberish checks with pygarble. Options and exit codes.
- [Contributing](https://brightertiger.github.io/pygarble/contributing.html): Contribute to pygarble: development setup, validation, rule changes, compatibility checks and optional backend tests.
- [Python examples](https://brightertiger.github.io/pygarble/examples.html): Runnable Python examples for local text screening, redaction, batching, English-field validation and explanations.
- [pygarble: a first line of defence for text](https://brightertiger.github.io/pygarble/): pygarble is a local Python library for PII detection, secret scanning, profanity detection, gibberish checks and redaction. No LLM calls.
- [Installation](https://brightertiger.github.io/pygarble/installation.html): Install pygarble and optional local screening backends. Understand released versions, source installs and dependencies.
- [Upgrading](https://brightertiger.github.io/pygarble/migration.html): Upgrade pygarble while preserving existing imports. Compare standalone screening with the original combined scanner.
- [PII](https://brightertiger.github.io/pygarble/pii.html): Detect emails, phone numbers, cards and structured identifiers with local patterns and checksums. PII coverage and locale packs.
- [Profanity](https://brightertiger.github.io/pygarble/profanity.html): Detect English profanity and obfuscated words locally. Configure word lists, severity tiers and allowlists without an LLM.
- [Publishing and discoverability](https://brightertiger.github.io/pygarble/publishing.html): Maintainer guide to pygarble releases, PyPI Trusted Publishing, Google Search Console and documentation discovery.
- [Quick start](https://brightertiger.github.io/pygarble/quickstart.html): Screen secrets, PII and profanity with pygarble, or check English gibberish independently. Runnable Python examples.
- [Combined screening and redaction](https://brightertiger.github.io/pygarble/screening.html): Use the compatible combined scanner for secrets, PII, profanity and gibberish. Findings, confidence and redaction modes.
- [Secrets](https://brightertiger.github.io/pygarble/secrets.html): Find API keys, private keys, credentials and generic secrets with pygarble. Native rules and optional local secret scanners.
- [Standalone screening and optional backends](https://brightertiger.github.io/pygarble/standalone-screening.html): Use pygarble.screening with native rules, phonenumbers, stdnum, detect-secrets and Gitleaks. Options and costs.
- [Detection Strategies](https://brightertiger.github.io/pygarble/strategies.html): Reference for pygarble's gibberish strategies, profile members and accepted configuration settings.
- [Choosing strategies](https://brightertiger.github.io/pygarble/strategy-guide.html): Choose pygarble gibberish detection profiles and strategies for English text, encoding problems and degenerate output.

## Project

- [Source and issues](https://github.com/brightertiger/pygarble)
- [Published package](https://pypi.org/project/pygarble/)

## Plain-text sources

Sphinx publishes reStructuredText sources alongside HTML. Autodoc directives are expanded in the HTML API reference.

- [api](https://brightertiger.github.io/pygarble/_sources/api.rst.txt)
- [architecture](https://brightertiger.github.io/pygarble/_sources/architecture.rst.txt)
- [benchmarks](https://brightertiger.github.io/pygarble/_sources/benchmarks.rst.txt)
- [calibration](https://brightertiger.github.io/pygarble/_sources/calibration.rst.txt)
- [cli](https://brightertiger.github.io/pygarble/_sources/cli.rst.txt)
- [contributing](https://brightertiger.github.io/pygarble/_sources/contributing.rst.txt)
- [examples](https://brightertiger.github.io/pygarble/_sources/examples.rst.txt)
- [index](https://brightertiger.github.io/pygarble/_sources/index.rst.txt)
- [installation](https://brightertiger.github.io/pygarble/_sources/installation.rst.txt)
- [migration](https://brightertiger.github.io/pygarble/_sources/migration.rst.txt)
- [pii](https://brightertiger.github.io/pygarble/_sources/pii.rst.txt)
- [profanity](https://brightertiger.github.io/pygarble/_sources/profanity.rst.txt)
- [publishing](https://brightertiger.github.io/pygarble/_sources/publishing.rst.txt)
- [quickstart](https://brightertiger.github.io/pygarble/_sources/quickstart.rst.txt)
- [screening](https://brightertiger.github.io/pygarble/_sources/screening.rst.txt)
- [secrets](https://brightertiger.github.io/pygarble/_sources/secrets.rst.txt)
- [standalone-screening](https://brightertiger.github.io/pygarble/_sources/standalone-screening.rst.txt)
- [strategies](https://brightertiger.github.io/pygarble/_sources/strategies.rst.txt)
- [strategy-guide](https://brightertiger.github.io/pygarble/_sources/strategy-guide.rst.txt)