New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewrite README #18
Rewrite README #18
Changes from 2 commits
920c27a
740fe94
79cae11
1145869
78bce93
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
======= | ||
marbles | ||
======= | ||
|
||
.. image:: https://img.shields.io/pypi/v/marbles.svg | ||
:target: https://pypi.python.org/pypi/marbles | ||
|
||
.. image:: https://img.shields.io/travis/twosigma/marbles.svg | ||
:target: https://travis-ci.org/twosigma/marbles | ||
|
||
.. image:: https://readthedocs.org/projects/marbles/badge/?version=latest | ||
:target: https://marbles.readthedocs.io/en/latest/?badge=latest | ||
:alt: Documentation Status | ||
|
||
.. image:: https://pyup.io/repos/github/twosigma/marbles/shield.svg | ||
:target: https://pyup.io/repos/github/twosigma/marbles/ | ||
:alt: Updates | ||
|
||
Read better test failures. | ||
|
||
* Free software: MIT license | ||
* Documentation: https://marbles.readthedocs.io. | ||
|
||
Overview | ||
-------- | ||
|
||
`marbles` is a Python `unittest` extension that allows test authors to write | ||
richer tests that expose more information on test failure to help you debug | ||
failing tests faster. | ||
|
||
* Treat test failures as documentation | ||
* Contextualize failures without digging through test code | ||
and dropping debugging statements everywhere | ||
* Write clearer, more explicit tests | ||
|
||
Features | ||
-------- | ||
|
||
* Drop-in `unittest` replacement | ||
* Information-rich failure messages | ||
|
||
* The full statement that failed (instead of just the last line) | ||
* Local variables in scope at the time the test failed | ||
* Optional annotation provided by the test author with details about the test | ||
* Ability to toggle traceback | ||
|
||
* Semantically-rich assertion methods | ||
|
||
Demo | ||
---- | ||
|
||
You can run the example tests provided to see what a `marbles` failure message | ||
looks like | ||
|
||
.. include:: docs/examples/getting_started.txt | ||
|
||
You can also run your existing `unittest` tests with `marbles` in two steps | ||
|
||
.. code-block:: bash | ||
|
||
python -m marbles test_module.py | ||
|
||
Installing | ||
---------- | ||
|
||
.. code-block:: bash | ||
|
||
pip install marbles | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's link to the contributing docs and I think we need to mention the license at the end of this. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I mention the license up at the top |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's not use pyup for this.