cricket python

A GUI tool for running Python test suites.

3 years after

.. image:: http://pybee.org/project/projects/tools/cricket/cricket.png :width: 72px :target: https://pybee.org/cricket

Cricket

.. image:: https://img.shields.io/pypi/pyversions/cricket.svg :target: https://pypi.python.org/pypi/cricket

.. image:: https://img.shields.io/pypi/v/cricket.svg :target: https://pypi.python.org/pypi/cricket

.. image:: https://img.shields.io/pypi/status/cricket.svg :target: https://pypi.python.org/pypi/cricket

.. image:: https://img.shields.io/pypi/l/cricket.svg :target: https://github.com/pybee/cricket/blob/master/LICENSE

.. image:: https://travis-ci.org/pybee/cricket.svg?branch=master :target: https://travis-ci.org/pybee/cricket

.. image:: https://badges.gitter.im/pybee/general.svg :target: https://gitter.im/pybee/general

Cricket is part of the BeeWare suite. The project website is http://pybee.org/cricket.

Cricket is a graphical tool that helps you run your test suites.

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, Balmer Peak limits come into effect, so something else is required...

.. _BeeWare suite: http://pybee.org/ .. _http://pybee.org/cricket: http://pybee.org/cricket .. _Test Cricket: http://en.wikipedia.org/wiki/Test_cricket .. _Balmer Peak: http://xkcd.com/323/

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.

Problems under Ubuntu


Ubuntu's packaging of Python omits the ``idlelib`` library from it's base
package. If you're using Python 2.7 on Ubuntu 13.04, you can install
``idlelib`` by running::

    $ sudo apt-get install idle-python2.7

For other versions of Python and Ubuntu, you'll need to adjust this as
appropriate.

Problems under Windows

If you're running Cricket in a virtualenv under Windows, you'll need to set an environment variable so that Cricket can find the TCL graphics library::

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

You'll need to adjust the exact path to reflect your local Python install. You may find it helpful to put this line in the activate.bat script for your virtual environment so that it is automatically set whenever the virtualenv is activated.

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 pybee/general_ channel on Gitter.

We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct_.

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_.

.. Read The Docs: https://cricket.readthedocs.io .. @pybeeware on Twitter: https://twitter.com/pybeeware .. _pybee/general: https://gitter.im/pybee/general .. _BeeWare Community Code of Conduct: http://pybee.org/community/behavior/ .. _log them on Github: https://github.com/pybee/cricket/issues .. _fork the code: https://github.com/pybee/cricket .. _submit a pull request: https://github.com/pybee/cricket/pulls

Related Repositories

open-cricket

open-cricket

Cricket API & Open Access to Cricket Stats. ...

cricbuzz.el

cricbuzz.el

Live cricket scores and schedule for emacs ...

Cricket-Analytics

Cricket-Analytics

Statistical and exploratory Analysis of Cricket Data ...

pycricket

pycricket

Get Cricket news in the terminal ...

get-cricket-data

get-cricket-data

Cricket match data and scripts for getting that data ...


Top Contributors

freakboy3742 elbaschid funkybob gopar r1chardj0n3s adamchainz idahogray lensvol Bachmann1234 phildini serdardalgic charettes DrMeers stephenmcd treyhunner

Releases

-   v0.2.3 zip tar
-   v0.2.2 zip tar
-   v0.2.1 zip tar
-   v0.2.0 zip tar
-   v0.1.3 zip tar
-   v0.1.2 zip tar
-   v0.1.1 zip tar
-   v0.1 zip tar