Skip to content

Cricket

Cricket is a graphical tool that helps projects with large test suites identify failures without waiting for all your tests to finish.

Normal unittest 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…

Tutorial

Get started with a hands-on introduction to Cricket for beginners.

How-to guides

Guides and recipes for common problems and tasks, including how to contribute to Cricket.

Topic guides

Deeper explorations of concepts and issues related to Cricket.

Reference

Technical reference for the public API provided by Cricket.

About Cricket

Frequently asked questions, community resources, and release history.

Community

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.