Skip to content
This repository was archived by the owner on Jan 13, 2023. It is now read-only.

Commit bdbb14c

Browse files
committed
Fixed build issue, improved docs.
1 parent 935dc9a commit bdbb14c

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

.travis.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ python:
44
- '2.7'
55
- '3.5'
66
- '3.6'
7-
install: pip install .
7+
install:
8+
- pip install .
9+
- pip install docutils # Used to check package metadata.
810
script:
911
- python setup.py check --strict --metadata --restructuredtext
1012
- nosetests

README.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,17 @@ To run unit tests after installing from source::
5858

5959
python setup.py test
6060

61-
PyOTA is also compatible with `tox`_::
61+
PyOTA is also compatible with `tox`_, which will run the unit tests in different
62+
virtual environments (one for each supported version of Python).
6263

63-
pip install tox
64-
tox
64+
To run the unit tests, it is recommended that you use the `detox`_ library.
65+
detox speeds up the tests by running them in parallel.
66+
67+
Install PyOTA with the ``test-runner`` extra to set up the necessary
68+
dependencies, and then you can run the tests with the ``detox`` command::
69+
70+
pip install -e .[test-runner]
71+
detox -v
6572

6673
=============
6774
Documentation
@@ -95,5 +102,6 @@ can also build the documentation locally:
95102
.. _ReadTheDocs: https://pyota.readthedocs.io/
96103
.. _Slack: https://slack.iota.org/
97104
.. _dedicated forum: https://forum.iota.org/
105+
.. _detox: https://pypi.python.org/pypi/detox
98106
.. _official API: https://iota.readme.io/
99107
.. _tox: https://tox.readthedocs.io/

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
extras_require = {
6868
'ccurl': ['pyota-ccurl'],
6969
'docs-builder': ['sphinx', 'sphinx_rtd_theme'],
70+
'test-runner': ['detox'],
7071
},
7172

7273
test_suite = 'test',

0 commit comments

Comments
 (0)