{"id":18921189,"url":"https://github.com/renanivo/pytest-testdox","last_synced_at":"2025-04-05T03:10:33.925Z","repository":{"id":12781412,"uuid":"72803387","full_name":"renanivo/pytest-testdox","owner":"renanivo","description":"A TestDox format reporter for pytest","archived":false,"fork":false,"pushed_at":"2025-03-01T01:25:46.000Z","size":198,"stargazers_count":47,"open_issues_count":6,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-29T02:08:21.905Z","etag":null,"topics":["bdd","hacktoberfest","pytest","reporting","test-reporting","testing"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/pytest-testdox/","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/renanivo.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-04T01:40:33.000Z","updated_at":"2025-03-24T22:10:19.000Z","dependencies_parsed_at":"2024-11-08T10:50:01.641Z","dependency_job_id":"f35f68f4-3336-41e5-96b4-e9d4253ef491","html_url":"https://github.com/renanivo/pytest-testdox","commit_stats":{"total_commits":213,"total_committers":10,"mean_commits":21.3,"dds":0.215962441314554,"last_synced_commit":"294754cc9272efaf442b974f5c83d6e412053813"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanivo%2Fpytest-testdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanivo%2Fpytest-testdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanivo%2Fpytest-testdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renanivo%2Fpytest-testdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renanivo","download_url":"https://codeload.github.com/renanivo/pytest-testdox/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247280272,"owners_count":20912967,"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","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":["bdd","hacktoberfest","pytest","reporting","test-reporting","testing"],"created_at":"2024-11-08T10:45:49.208Z","updated_at":"2025-04-05T03:10:33.906Z","avatar_url":"https://github.com/renanivo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pytest-testdox\n\n[![PyPI](https://img.shields.io/pypi/v/pytest-testdox.svg?color=brightgreen)](https://pypi.org/project/pytest-testdox/)\n[![Continuous Integration Status](https://github.com/renanivo/pytest-testdox/workflows/Continuous%20Integration/badge.svg)](https://github.com/renanivo/pytest-testdox/actions?query=workflow%3A%22Continuous+Integration%22)\n[![codecov](https://codecov.io/gh/renanivo/pytest-testdox/branch/master/graph/badge.svg)](https://codecov.io/gh/renanivo/pytest-testdox)\n\nA [TestDox format](https://en.wikipedia.org/wiki/TestDox) reporter for pytest.\n\n![](https://i.imgur.com/rJRL4x9.png)\n\n## Install\n\n```\npip install pytest-testdox\n```\n\n## Usage\n\nAdd the parameter `--testdox` when running `pytest`. For example:\n\n```sh\npytest --testdox your-tests/\n```\n\nTip: If you don't want to type `--testdox` every time you run `pytest`, add it\nto [`addopts`](https://docs.pytest.org/en/latest/customize.html#confval-addopts)\nin your [ini file](https://docs.pytest.org/en/latest/customize.html#initialization-determining-rootdir-and-inifile).\nFor example:\n\n```ini\n# content of pytest.ini or tox.ini\n[pytest]\naddopts = --testdox\n\n# or if you use setup.cfg\n[tool:pytest]\naddopts = --testdox\n```\n\nWhen using `--testdox`, the plugin will disable itself when not running on a\nterminal. If you want the testdox report no matter what, use the parameter\n`--force-testdox` instead.\n\n\n## Markers\n\n### @pytest.mark.describe\n\nOverride the class name in the testdox report. For example:\n\n```python\n# test_demo.py\n@pytest.mark.describe('create_file')\nclass TestCreateFile():\n\n    def test_creates_a_file_in_the_so(self):\n        pass\n```\n\nWill produce the output:\n\n```\ntest_demo.py\n\ncreate_file\n [x] creates a file in the so\n```\n\n### @pytest.mark.it\n\nOverride the test title in the testdox report. For example:\n\n```python\n# test_demo.py\nclass TestCreateFile():\n\n    @pytest.mark.it('Creates a local file in the SO')\n    def test_creates_a_file_in_the_so(self):\n        pass\n```\n\nWill produce the output:\n\n\n```\ntest_demo.py\n\nCreate File\n [x] Creates a local file in the SO\n```\n\n## Configuration file options\n\n### testdox_format\n\nSpecifies TestDox report format, `plaintext` or `utf8` (default:\n`utf8`). For example:\n\n```ini\n# content of pytest.ini\n# (or tox.ini or setup.cfg)\n[pytest]\ntestdox_format = plaintext\n```\n\n```console\n$ pytest test_demo.py\n============================= test session starts ==============================\nplatform darwin -- Python 3.5.0, pytest-3.0.7, py-1.4.33, pluggy-0.4.0\nrootdir: /private/tmp/demo, inifile: pytest.ini\nplugins: testdox-dev\ncollected 2 items\n\ntest_demo.py\nPytest Testdox\n [x] prints a BDD style output to your tests\n [x] lets you focus on the behavior\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenanivo%2Fpytest-testdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenanivo%2Fpytest-testdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenanivo%2Fpytest-testdox/lists"}