Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackevansevo committed Jun 13, 2017
1 parent c884d1b commit f42b1ae
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ Basic utils
Useful utilities for Python 3.4+


Currently alpha, (so use at your own risk)

Documentation
=============

Expand All @@ -35,10 +33,30 @@ Install through PyPi with the following::
Tests
=====

Install requirements and run ::
(Optional) Create a virtualenv:

.. code-block:: bash
python3 -m venv venv
.. code-block:: bash
venv/bin/activate
Install requirements

.. code-block:: bash
pip install -e ."[test]"
Install requirements and run:

.. code-block:: bash
pytest
To get get coverage (including branch coverage) ::
To get get coverage (including branch coverage):

.. code-block:: bash
coverage run --branch -m pytest && coverage report -m
scripts/test

0 comments on commit f42b1ae

Please sign in to comment.