.. image:: https://beeware.org/project/projects/tools/cricket/cricket.png :width: 72px :target: https://beeware.org/cricket
.. image:: https://img.shields.io/pypi/pyversions/cricket.svg :target: https://pypi.python.org/pypi/cricket :alt: Python versions
.. image:: https://img.shields.io/pypi/v/cricket.svg :target: https://pypi.python.org/pypi/cricket :alt: Project version
.. image:: https://img.shields.io/pypi/status/cricket.svg :target: https://pypi.python.org/pypi/cricket :alt: Development status
.. image:: https://img.shields.io/pypi/l/cricket.svg :target: https://github.com/beeware/cricket/blob/main/LICENSE :alt: Project license
.. image:: https://github.com/beeware/cricket/workflows/CI/badge.svg?branch=main :target: https://github.com/beeware/cricket/actions :alt: Build Status
.. image:: https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic :target: https://beeware.org/bee/chat/ :alt: Discord server
Cricket is part of the BeeWare suite. The project website is http://beeware.org/cricket.
Cricket is a graphical tool that helps you run your test suites.
Normal test runners dump all output to the console, and provide very little detail while the suite is running. As a result:
You can't start looking at failures until the test suite has completed running,
It isn't a very accessible format for identifying patterns in test failures,
It can be hard (or cumbersome) to re-run any tests that have failed.
Why the name cricket? Test Cricket is the most prestigious version of
the game of cricket. Games last for up to 5 days... just like running some
test suites. The usual approach for making cricket watchable is a generous
dose of beer; in programming, Ballmer Peak limits come into effect, so
something else is required...
.. _BeeWare suite: http://beeware.org/ .. _http://beeware.org/cricket: http://beeware.org/cricket .. _Test Cricket: http://en.wikipedia.org/wiki/Test_cricket .. _Ballmer Peak: http://xkcd.com/323/
At present, Cricket has support for:
pytest <https://pytest.org>__ test suites; andDjango <https://djangoproject.com>__ 1.6+ project test suitesTo use Cricket, install it with pip::
$ pip install cricketThen, to run your unittest suite::
$ cricket-unittestOr, in a pytest project::
$ cricket-pytestOr, in a Django project::
$ cricket-djangocricket-django will also work in Django's own tests directory -- i.e., you
can use cricket-django to run Django's own test suite (for Django 1.6 or
later).
Running cricket will display a GUI window. Hit "Run all", and watch your test suite execute. A progress bar is displayed in the bottom right hand corner of the window, along with an estimate of time remaining.
While the suite is running, you can click on test names to see the output of that test. The icon in the tree, and the summary panel on the right, will display the status of the test, as well as any output or error text.
Documentation for cricket can be found on Read The Docs_.
Cricket is part of the BeeWare suite_. You can talk to the community through:
@pybeeware on Twitter_
Discord <https://beeware.org/bee/chat/>__
We foster a welcoming and respectful community as described in our
BeeWare Community Code of Conduct_.
Icons for Cricket come from Icons8 <https://icons8.com>, and are used under the terms of a CC BY-ND 3.0 <https://creativecommons.org/licenses/by-nd/3.0/> license.
If you experience problems with cricket, log them on GitHub. If you want to contribute code, please fork the code and submit a pull request_.
.. Read The Docs: https://cricket.readthedocs.io .. @pybeeware on Twitter: https://twitter.com/pybeeware .. _BeeWare Community Code of Conduct: http://beeware.org/community/behavior/ .. _log them on Github: https://github.com/beeware/cricket/issues .. _fork the code: https://github.com/beeware/cricket .. _submit a pull request: https://github.com/beeware/cricket/pulls