Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.68 KB

File metadata and controls

34 lines (27 loc) · 1.68 KB

example-python

coverage badge complexity badge

A small, idiomatic Python text-analysis toolkit used as the Python reference example for Coverage Tracker. It exists to give the Python row in the coverage report generation guide a live, working reference, and to populate the demo dashboard with real trend data.

This is a demo/marketing repo, not a test suite for Coverage Tracker itself.

What's here

  • textkit/ — readability scoring, slug generation, and word-frequency helpers, each with real branching logic.
  • tests/ — a pytest suite with a few deliberately uncovered branches, so branch_coverage < line_coverage shows up on the dashboard.
  • .github/workflows/coverage.yml — runs tests under coverage.py, generates a Radon complexity report, then reports both to the demo instance via the coverage-tracker reporting Action.

Running locally

pip install -e ".[dev]"
coverage run -m pytest && coverage lcov -o coverage.lcov   # writes coverage.lcov
radon cc -j textkit > radon.json