{"id":13937562,"url":"https://github.com/beeware/cricket","last_synced_at":"2025-04-06T06:12:03.454Z","repository":{"id":8966262,"uuid":"10707388","full_name":"beeware/cricket","owner":"beeware","description":"A GUI tool for running Python test suites.","archived":false,"fork":false,"pushed_at":"2024-05-26T14:32:10.000Z","size":983,"stargazers_count":215,"open_issues_count":23,"forks_count":69,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-03-30T05:05:41.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beeware.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","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":"AUTHORS","dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["freakboy3742"],"custom":["http://beeware.org/bee/join"]}},"created_at":"2013-06-15T14:36:53.000Z","updated_at":"2025-01-18T22:54:12.000Z","dependencies_parsed_at":"2023-02-10T00:46:07.961Z","dependency_job_id":"862c37f7-5342-4cc0-80dc-810c22ec9a2a","html_url":"https://github.com/beeware/cricket","commit_stats":{"total_commits":310,"total_committers":25,"mean_commits":12.4,"dds":"0.40645161290322585","last_synced_commit":"a8f6545f30c3e95492301a65e9d808be7cfa8971"},"previous_names":["pybee/cricket"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fcricket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fcricket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fcricket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fcricket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beeware","download_url":"https://codeload.github.com/beeware/cricket/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441057,"owners_count":20939239,"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":[],"created_at":"2024-08-07T23:03:41.109Z","updated_at":"2025-04-06T06:12:03.436Z","avatar_url":"https://github.com/beeware.png","language":"Python","funding_links":["https://github.com/sponsors/freakboy3742","http://beeware.org/bee/join"],"categories":["Python"],"sub_categories":[],"readme":".. image:: https://beeware.org/project/projects/tools/cricket/cricket.png\n    :width: 72px\n    :target: https://beeware.org/cricket\n\nCricket\n=======\n\n.. image:: https://img.shields.io/pypi/pyversions/cricket.svg\n    :target: https://pypi.python.org/pypi/cricket\n    :alt: Python versions\n\n.. image:: https://img.shields.io/pypi/v/cricket.svg\n    :target: https://pypi.python.org/pypi/cricket\n    :alt: Project version\n\n.. image:: https://img.shields.io/pypi/status/cricket.svg\n    :target: https://pypi.python.org/pypi/cricket\n    :alt: Development status\n\n.. image:: https://img.shields.io/pypi/l/cricket.svg\n    :target: https://github.com/beeware/cricket/blob/main/LICENSE\n    :alt: Project license\n\n.. image:: https://github.com/beeware/cricket/workflows/CI/badge.svg?branch=main\n   :target: https://github.com/beeware/cricket/actions\n   :alt: Build Status\n\n.. image:: https://img.shields.io/discord/836455665257021440?label=Discord%20Chat\u0026logo=discord\u0026style=plastic\n   :target: https://beeware.org/bee/chat/\n   :alt: Discord server\n\nCricket is part of the `BeeWare suite`_. The project website is `http://beeware.org/cricket`_.\n\nCricket is a graphical tool that helps you run your test suites.\n\nNormal test runners dump all output to the console, and provide very little\ndetail while the suite is running. As a result:\n\n* You can't start looking at failures until the test suite has completed running,\n\n* It isn't a very accessible format for identifying patterns in test failures,\n\n* It can be hard (or cumbersome) to re-run any tests that have failed.\n\nWhy the name ``cricket``? `Test Cricket`_ is the most prestigious version of\nthe game of cricket. Games last for up to 5 days... just like running some\ntest suites. The usual approach for making cricket watchable is a generous\ndose of beer; in programming, `Ballmer Peak`_ limits come into effect, so\nsomething else is required...\n\n.. _BeeWare suite: http://beeware.org/\n.. _http://beeware.org/cricket: http://beeware.org/cricket\n.. _Test Cricket: http://en.wikipedia.org/wiki/Test_cricket\n.. _Ballmer Peak: http://xkcd.com/323/\n\n\nQuickstart\n----------\n\nAt present, Cricket has support for:\n\n* unittest test suites; and\n* `pytest \u003chttps://pytest.org\u003e`__ test suites; and\n* `Django \u003chttps://djangoproject.com\u003e`__ 1.6+ project test suites\n\nTo use Cricket, install it with pip::\n\n    $ pip install cricket\n\nThen, to run your unittest suite::\n\n    $ cricket-unittest\n\nOr, in a pytest project::\n\n    $ cricket-pytest\n\nOr, in a Django project::\n\n    $ cricket-django\n\n``cricket-django`` will also work in Django's own tests directory -- i.e., you\ncan use ``cricket-django`` to run Django's own test suite (for Django 1.6 or\nlater).\n\nRunning cricket will display a GUI window. Hit \"Run all\", and watch your test\nsuite execute. A progress bar is displayed in the bottom right hand corner of\nthe window, along with an estimate of time remaining.\n\nWhile the suite is running, you can click on test names to see the output of\nthat test. The icon in the tree, and the summary panel on the right, will\ndisplay the status of the test, as well as any output or error text.\n\nDocumentation\n-------------\n\nDocumentation for cricket can be found on `Read The Docs`_.\n\nCommunity\n---------\n\nCricket is part of the `BeeWare suite`_. You can talk to the community through:\n\n* `@pybeeware on Twitter`_\n\n* `Discord \u003chttps://beeware.org/bee/chat/\u003e`__\n\nWe foster a welcoming and respectful community as described in our\n`BeeWare Community Code of Conduct`_.\n\nAcknowledgements\n----------------\n\nIcons for Cricket come from `Icons8 \u003chttps://icons8.com\u003e`__, and are used under the terms of a `CC BY-ND 3.0 \u003chttps://creativecommons.org/licenses/by-nd/3.0/\u003e`__ license.\n\nContributing\n------------\n\nIf you experience problems with cricket, `log them on GitHub`_. If you want to contribute code, please `fork the code`_ and `submit a pull request`_.\n\n.. _Read The Docs: https://cricket.readthedocs.io\n.. _@pybeeware on Twitter: https://twitter.com/pybeeware\n.. _BeeWare Community Code of Conduct: http://beeware.org/community/behavior/\n.. _log them on Github: https://github.com/beeware/cricket/issues\n.. _fork the code: https://github.com/beeware/cricket\n.. _submit a pull request: https://github.com/beeware/cricket/pulls\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fcricket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeeware%2Fcricket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fcricket/lists"}