{"id":13501512,"url":"https://github.com/darrenburns/ward","last_synced_at":"2025-02-27T22:30:47.307Z","repository":{"id":37892880,"uuid":"164605649","full_name":"darrenburns/ward","owner":"darrenburns","description":"Ward is a modern test framework for Python with a focus on productivity and readability.","archived":true,"fork":false,"pushed_at":"2024-08-26T22:58:48.000Z","size":14788,"stargazers_count":1211,"open_issues_count":51,"forks_count":54,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-02-23T00:53:13.342Z","etag":null,"topics":["contributors-welcome","python","quality-assurance","test-runner","tester","testing","testing-framework","unit-test","ward"],"latest_commit_sha":null,"homepage":"https://ward.readthedocs.io","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/darrenburns.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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":"2019-01-08T08:50:58.000Z","updated_at":"2025-02-13T17:28:58.000Z","dependencies_parsed_at":"2023-11-13T22:25:04.546Z","dependency_job_id":"b1cf2ce8-5360-4af1-a9d3-505485bc2dd2","html_url":"https://github.com/darrenburns/ward","commit_stats":{"total_commits":841,"total_committers":36,"mean_commits":23.36111111111111,"dds":0.4007134363852557,"last_synced_commit":"1c54620de843c8286691fb90836faddd1c0be14e"},"previous_names":[],"tags_count":94,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darrenburns%2Fward","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darrenburns%2Fward/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darrenburns%2Fward/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darrenburns%2Fward/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darrenburns","download_url":"https://codeload.github.com/darrenburns/ward/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240254160,"owners_count":19772389,"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":["contributors-welcome","python","quality-assurance","test-runner","tester","testing","testing-framework","unit-test","ward"],"created_at":"2024-07-31T22:01:40.010Z","updated_at":"2025-02-27T22:30:46.784Z","avatar_url":"https://github.com/darrenburns.png","language":"Python","funding_links":[],"categories":["Test Frameworks","Python","Testing Frameworks"],"sub_categories":["Python"],"readme":"\u003cimg src=\"https://user-images.githubusercontent.com/5740731/119056107-085c6900-b9c2-11eb-9699-f54ef4945623.png\" width=\"350px\"\u003e\n\n[![Codecov](https://codecov.io/gh/darrenburns/ward/branch/master/graph/badge.svg)](https://codecov.io/gh/darrenburns/ward)\n[![Documentation Status](https://readthedocs.org/projects/ward/badge/?version=latest)](https://ward.readthedocs.io/en/latest/?badge=latest)\n[![PyPI version](https://badge.fury.io/py/ward.svg)](https://badge.fury.io/py/ward)\n\n\u003chr\u003e\n\n_Ward_ is a Python testing framework with a focus on productivity and readability. It gives you the tools you need to write **well-documented** and **scalable** tests.\n\n\u003e [!IMPORTANT]  \n\u003e I am no longer actively maintaining this project.\n\n\u003cimg alt=\"Ward typical test output example\" src=\"https://user-images.githubusercontent.com/5740731/118399779-a795ff00-b656-11eb-8fca-4ceb03151f3e.png\"\u003e\n\n## Features\n\nSee the full set of features in the [**documentation**](https://ward.readthedocs.io).\n\n**Descriptive test names:** describe what your tests do using strings, not function names.\n```python\n@test(\"simple addition\")  # you can use markdown in these descriptions!\ndef _():\n    assert 1 + 2 == 3  # you can use plain assert statements!\n```\n\n**Modular test dependencies:** manage test setup/teardown code using fixtures that rely on Python's import system, not\nname matching.\n```python\n@fixture\ndef user():\n    return User(name=\"darren\")\n\n\n@test(\"the user is called darren\")\ndef _(u=user):\n    assert u.name == \"darren\"\n```\n\n**Support for asyncio**: define your tests and fixtures with `async def` and call asynchronous code within them.\n\n```python\n@fixture\nasync def user():\n    u = await create_user()\n    return await u.login()\n\n\n@test(\"the logged in user has a last session date\")\nasync def _(user=user):\n    last_session = await get_last_session_date(user.id)\n    assert is_recent(last_session, get_last_session_date)\n```\n\n**Powerful test selection:** limit your test run not only by matching test names/descriptions, but also on the code\ncontained in the body of the test.\n```\nward --search \"Database.get_all_users\"\n```\nOr use tag expressions for more powerful filtering.\n```\nward --tags \"(unit or integration) and not slow\"\n```\n\n**Parameterised testing:** write a test once, and run it multiple times with different inputs by writing it in a loop.\n```python\nfor lhs, rhs, res in [\n    (1, 1, 2),\n    (2, 3, 5),\n]:\n\n    @test(\"simple addition\")\n    def _(left=lhs, right=rhs, result=res):\n        assert left + right == result\n```\n\n**Cross platform:** Tested on Mac OS, Linux, and Windows.\n\n**Speedy:** Ward's suite of ~320 tests run in less than half a second on my machine.\n\n**Zero config:** Sensible defaults mean running `ward` with no arguments is enough to get started. Can be configured using `pyproject.toml` or the command line if required.\n\n**Extendable:** Ward has a plugin system built with pluggy, the same framework used by pytest.\n\n**Colourful, human readable output:** quickly pinpoint and fix issues with detailed output for failing tests.\n\n\u003cimg alt=\"Ward failing test output example\" src=\"https://user-images.githubusercontent.com/5740731/120125898-5dfaf780-c1b2-11eb-9acd-b9cd0ff24110.png\"\u003e\n\n## Getting Started\n\nHave a look at the [**documentation**](https://ward.readthedocs.io)!\n\n## How to Contribute\n\nContributions are very welcome and encouraged!\n\nSee the [contributing guide](.github/CONTRIBUTING.md) for information on how you can take part in the development of Ward.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarrenburns%2Fward","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarrenburns%2Fward","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarrenburns%2Fward/lists"}