Cricket is part of the BeeWare suite.
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...
Cricket can run any test suite that can be run run with pytest.
To use Cricket, install it with pip:
$ pip install cricket
Then, to run your unittest suite:
$ cricket
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:
We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct.
If you experience problems with Cricket, log them on GitHub.
If you want to contribute, please fork the project and submit a pull request.
Icons for Cricket come from Icons8, and are used under the terms of a CC BY-ND 3.0 license.