{"id":30558363,"url":"https://github.com/petereon/ward-coverage","last_synced_at":"2025-08-28T08:29:20.931Z","repository":{"id":51002375,"uuid":"495687913","full_name":"petereon/ward-coverage","owner":"petereon","description":"A coverage plugin for Python's Ward testing framework","archived":false,"fork":false,"pushed_at":"2023-12-20T11:50:47.000Z","size":360,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-19T03:50:25.119Z","etag":null,"topics":["coverage","python","testing","ward"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/petereon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-24T05:55:14.000Z","updated_at":"2025-05-12T15:27:04.000Z","dependencies_parsed_at":"2023-02-09T20:30:32.343Z","dependency_job_id":null,"html_url":"https://github.com/petereon/ward-coverage","commit_stats":null,"previous_names":["petereon/ward_coverage"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/petereon/ward-coverage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petereon%2Fward-coverage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petereon%2Fward-coverage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petereon%2Fward-coverage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petereon%2Fward-coverage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/petereon","download_url":"https://codeload.github.com/petereon/ward-coverage/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petereon%2Fward-coverage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272469914,"owners_count":24939925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-28T02:00:10.768Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coverage","python","testing","ward"],"created_at":"2025-08-28T08:29:20.852Z","updated_at":"2025-08-28T08:29:20.921Z","avatar_url":"https://github.com/petereon.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ward Coverage\n\n[![CI/CD](https://github.com/petereon/ward_coverage/actions/workflows/python-test.yml/badge.svg?branch=master)](https://github.com/petereon/ward_coverage/actions/workflows/python-test.yml) \n[![MyPy Lint](https://github.com/petereon/ward_coverage/actions/workflows/python-lint.yml/badge.svg?branch=master)](https://github.com/petereon/ward_coverage/actions/workflows/python-lint.yml) \n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=petereon_ward_coverage\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=petereon_ward_coverage)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/ward-coverage)\n\n__Disclaimer: Albeit useful already, this is a work-in-progress and should be seen as such.__ \n\nA coverage plugin for Python's [Ward testing framework](https://ward.readthedocs.io/en/latest/)\n\n![Example image](https://raw.githubusercontent.com/petereon/ward-coverage/master/resources/screen.png)\n\n## Installation\n\nBuild the plugin:\n\n```bash\npoetry build\n```\nand install using\n\n```bash\npip install dist/ward_coverage-0.1.1-py3-none-any.whl\n```\n\n## Configuration\n\nTo include coverage in your test run, add the following to your `pyproject.toml`:\n\n```toml\n[tool.ward]\nhook_module = [\"ward_coverage\"]\n```\n\nThere are several options to configure the plugin which can be included under section `[tool.ward.plugins.coverage]`, namely:\n- `report_type`, defaulting to `[\"term\"]`, which is a list of report types to generate. Possible values are one or more of _'lcov'_, _'html'_, _'xml'_, _'json'_, _'term'_\n- `threshold` for minimum coverage, affecting the color the result panel has for some sort of visual cue\n- All of the options described [here](https://coverage.readthedocs.io/en/6.4.4/config.html#run-source-pkgs). Please note that everything here under [`[run]` section](https://coverage.readthedocs.io/en/6.4.4/config.html#run) goes to  `[tool.ward.plugins.coverage]` and other sections need their separate block (e.g `[tool.ward.plugins.coverage.report]`) or dictionary entry within the `[tool.ward.plugins.coverage]` section in toml.\n\n### Example configuration\n```toml\n[tool.ward.plugins.coverage]\nomit = [\"*test*\", \"example.py\", \"**/__init__.py\"]\nreport_type = [\"term\", \"xml\"]\nsource = [\".\"]\nbranch = true\nrelative_files = true\nreport = {skip_empty = true}\n```\n\n__Contributors, issues and feature requests are welcome.__\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetereon%2Fward-coverage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetereon%2Fward-coverage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetereon%2Fward-coverage/lists"}