Skip to content

Implementation Checklist

Package Root

  • [x] pyproject.toml with extras and entry points
  • [x] README.md with badges and full documentation
  • [x] LICENSE
  • [x] CHANGELOG.md
  • [x] CONTRIBUTING.md
  • [x] SECURITY.md
  • [x] CLAUDE.md
  • [x] Makefile
  • [x] noxfile.py
  • [x] .pre-commit-config.yaml
  • [x] GitHub Actions CI and release workflows

Source Package

  • [x] Public API (get_logger, setup, configure, context helpers)
  • [x] Bootstrap with thread safety and idempotency
  • [x] Settings models (logging, rich, context, structlog, otel)
  • [x] Settings validation for invalid combinations
  • [x] Handler factories (rich, stream, file, queue)
  • [x] Formatter helpers (JSON, key-value, text)
  • [x] Context helpers (vars, managers, decorators, request)
  • [x] Context filter for log record injection
  • [x] ASGI middleware with request context
  • [x] FastAPI installation helper
  • [x] Celery signal-based context binding
  • [x] httpx request/response logging hooks
  • [x] RQ worker job context
  • [x] SQLAlchemy engine logging
  • [x] structlog configuration, processors, renderers, bridge
  • [x] OpenTelemetry traces, logs, metrics, correlation, propagation
  • [x] Optional import helpers with graceful degradation
  • [x] CLI with doctor, demo, show-config, validate
  • [x] Testing utilities (reset, capture, factories)
  • [x] Console script entry point

Tests

  • [x] Unit tests (30+ tests)
  • [x] Integration tests (8+ tests)
  • [x] E2E tests (5+ tests)
  • [x] Async context isolation tests
  • [x] Bootstrap reconfiguration tests
  • [x] Settings validation tests
  • [x] Fixture isolation

Documentation

  • [x] Quickstart
  • [x] Architecture
  • [x] Testing strategy
  • [x] Cookbook
  • [x] Roadmap
  • [x] Concept guides (bootstrap, context, presets, lifecycle)
  • [x] Integration guides (Rich, structlog, OTel, web frameworks)
  • [x] Settings reference
  • [x] Public API reference
  • [x] ADRs (8 decisions)
  • [x] Module reference pages

Future

  • [ ] Prometheus / Grafana / Loki / Jaeger specific recipes
  • [ ] Log sampling and rate limiting
  • [ ] Copier or cookiecutter project template