diff --git a/.gitignore b/.gitignore index 9fab864..e27f53a 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,7 @@ distribute-* .DS_Store .*.sw[op] *~ + +# IntelliJ Idea family of suites +.idea +*.iml diff --git a/README.md b/README.md new file mode 100644 index 0000000..47a921f --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +[image](https://beeware.org/cricket) + +# Cricket + +[![Python versions](https://img.shields.io/pypi/pyversions/cricket.svg)](https://pypi.python.org/pypi/cricket) + +[![Project version](https://img.shields.io/pypi/v/cricket.svg)](https://pypi.python.org/pypi/cricket) + +[![Development status](https://img.shields.io/pypi/status/cricket.svg)](https://pypi.python.org/pypi/cricket) + +[![Project license](https://img.shields.io/pypi/l/cricket.svg)](https://github.com/beeware/cricket/blob/main/LICENSE) + +[![Build Status](https://github.com/beeware/cricket/workflows/CI/badge.svg?branch=main)](https://github.com/beeware/cricket/actions) + +[![Discord server](https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic)](https://beeware.org/bee/chat/) + +Cricket is part of the [BeeWare suite](https://beeware.org). The project +website is [https://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](http://en.wikipedia.org/wiki/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](http://xkcd.com/323/) limits come into effect, so +something else is required... + +## Quickstart + +At present, Cricket has support for: + +- unittest test suites; and +- [pytest](https://pytest.org) test suites; and +- [Django](https://djangoproject.com) 1.6+ project test suites + +To use Cricket, install it with pip: + + $ pip install cricket + +Then, to run your unittest suite: + + $ cricket-unittest + +Or, in a pytest project: + + $ cricket-pytest + +Or, in a Django project: + + $ 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). + +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 + +Documentation for cricket can be found on [Read The +Docs](https://cricket.readthedocs.io). + +## Community + +Cricket is part of the [BeeWare suite](https://beeware.org). You can +talk to the community through: + +- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware) +- [Discord](https://beeware.org/bee/chat/) + +We foster a welcoming and respectful community as described in our +[BeeWare Community Code of +Conduct](https://beeware.org/community/behavior/). + +## Contributing + +If you experience problems with Cricket, [log them on +GitHub](https://github.com/beeware/cricket/issues). + +If you want to contribute, please [fork the +project](https://github.com/beeware/cricket) and [submit a pull +request](https://github.com/beeware/cricket/pulls). + +## Acknowledgements + +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. diff --git a/README.rst b/README.rst deleted file mode 100644 index 863177f..0000000 --- a/README.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. image:: https://beeware.org/project/projects/tools/cricket/cricket.png - :width: 72px - :target: https://beeware.org/cricket - -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 `https://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/ -.. _https://beeware.org/cricket: http://beeware.org/cricket -.. _Test Cricket: http://en.wikipedia.org/wiki/Test_cricket -.. _Ballmer Peak: http://xkcd.com/323/ - - -Quickstart ----------- - -At present, Cricket has support for: - -* unittest test suites; and -* `pytest `__ test suites; and -* `Django `__ 1.6+ project test suites - -To use Cricket, install it with pip:: - - $ pip install cricket - -Then, to run your unittest suite:: - - $ cricket-unittest - -Or, in a pytest project:: - - $ cricket-pytest - -Or, in a Django project:: - - $ 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). - -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 -------------- - -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: - -* `@beeware@fosstodon.org on Mastodon `__ - -* `Discord `__ - -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, please `fork the project `__ and `submit a pull request `__. - -Acknowledgements ----------------- - -Icons for Cricket come from `Icons8 `__, and are used under the terms of a `CC BY-ND 3.0 `__ license. diff --git a/setup.cfg b/setup.cfg index e3dbac7..0e9c547 100644 --- a/setup.cfg +++ b/setup.cfg @@ -11,4 +11,4 @@ max-line-length = 119 ignore = E121,E123,E126,E226,E24,E704,W503,W504,C901 [metadata] -description-file = README.rst +description-file = README.md diff --git a/setup.py b/setup.py index 231d5a4..49904a0 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ raise RuntimeError("Unable to find version string.") -with io.open('README.rst', encoding='utf8') as readme: +with io.open('README.md', encoding='utf8') as readme: long_description = readme.read()