Permalink
Browse files

Miscellaneous doc fixes (#89)

* Add conda installation instructions and fix GitHub link #88

* Groomin'

* Replace demo codeblock with a screenshot to bring some damn life to this README
  • Loading branch information...
thejunglejane authored and leifwalsh committed Aug 19, 2018
1 parent 4078af4 commit 11e2d157b21de05ac4d15f3c11e824d76683ecff
Showing with 13 additions and 24 deletions.
  1. +1 −24 README.rst
  2. +1 −0 docs/changelog.rst
  3. +11 −0 docs/install.rst
  4. BIN getting_started.png
@@ -57,30 +57,7 @@ Demo
You can run the example tests provided to see what a `marbles` failure message
looks like

.. code-block:: none

python -m marbles docs/examples/getting_started.py
F
======================================================================
FAIL: test_create_resource (docs.examples.getting_started.ResponseTestCase)
----------------------------------------------------------------------
marbles.core.marbles.ContextualAssertionError: 409 != 201

Source (/path/to/docs/examples/getting_started.py):
39 res = requests.put(endpoint, data=data)
> 40 self.assertEqual(
41 res.status_code,
42 201
43 )
Locals:
endpoint=http://example.com/api/v1/resource
data={'name': 'Little Bobby Tables', 'id': 1}


----------------------------------------------------------------------
Ran 1 test in 0.002s

FAILED (failures=1)
.. image:: getting_started.png

You can also run your existing `unittest` tests with `marbles`

@@ -2,6 +2,7 @@
Changelog
=========

* :support:`88` Document how to install with conda
* :release:`0.9.5 <2018-06-24>`
* :support:`80` Added support for ``pandas<0.24``
* :bug:`58` Fixed test failure on OSX
@@ -27,11 +27,22 @@ To install marbles with pip
.. _install-source:

conda
-----

To install marbles with conda

.. code-block:: bash
conda install -c conda-forge marbles
Source
------

If you need a copy of the source, you can clone the `GitHub`_ repository or download the `tarball`_.

.. _GitHub: https://github.com/twosigma/marbles

GitHub
^^^^^^

BIN +204 KB getting_started.png
Binary file not shown.

0 comments on commit 11e2d15

Please sign in to comment.