Quickstart

At present, Cricket has support for:

• Pre-Django 1.6 project test suites,

• Django 1.6+ project test suites using unittest2-style discovery, and

• unittest project test suites.

In your Django project, install cricket, and then run it:

$ pip install cricket
$ cricket-django

cricket-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).

In a unittest project, install cricket, and then run it:

$ pip install cricket
$ cricket-unittest

This will pop up 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. If the test passed, it will be displayed in green; other test results will be shown in other colors.

$ sudo apt-get install idle-python2.7

$ set TCL_LIBRARY=c:\Python27\tcl\tcl8.5

Documentation

Documentation for cricket can be found on Read The Docs.

Community

Cricket is part of the BeeWare suite. You can talk to the community through:

• @pybeeware on Twitter

• The BeeWare Users Mailing list, for questions about how to use the BeeWare suite.

• The BeeWare Developers Mailing list, for discussing the development of new features in the BeeWare suite, and ideas for new tools for the suite.

Contributing

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.