hushlog 0.1.0a3

Zero-config PII redaction for Python logging

HushLog

Zero-config PII redaction for Python logging.

Features

• Zero-config — one call to hushlog.patch() and you're done
• Non-invasive — wraps existing formatters, no logger rewrites needed
• Performant — pre-compiled regex with heuristic early-exit checks
• Type-safe — fully typed with PEP 561 py.typed marker
• Python 3.10+ — supports Python 3.10 through 3.13

Installation

pip install hushlog

Or with uv:

uv add hushlog

Quick Start

import logging
import hushlog

hushlog.patch()

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

logger.info("User email: [e-mail]")
# Output: User email: [EMAIL REDACTED]

logger.info("Card: 4111-1111-1111-1111")
# Output: Card: [CREDIT_CARD REDACTED]

What Gets Redacted

Pattern	Example Input	Redacted Output
Email	[e-mail]	[EMAIL REDACTED]
Credit Card	4111-1111-1111-1111	[CREDIT_CARD REDACTED]
SSN	123-45-6789	[SSN REDACTED]
Phone	[phone]	[PHONE REDACTED]

Credit card detection includes Luhn checksum validation to minimize false positives.

Planned Patterns (v0.2.0+)

IPv4/IPv6 addresses, AWS keys, Stripe keys, GitHub tokens, JWT tokens, and more. See the roadmap for details.

Configuration

Disable specific patterns or add custom ones:

from hushlog import Config

hushlog.patch(Config(
    disable_patterns=frozenset({"phone"}),
    custom_patterns={"internal_id": r"ID-[A-Z]{3}-[0-9]{6}"},
))

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

License

MIT -- see LICENSE for details.