Skip to content
Merged

Tox #482

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,24 @@ Then, run the tests:

make test

Alternatively you can use tox. Its used for testing the package against different python versions in one go. Just make sure you have the python versions available globally or in your virtual environment

Install tox

`pip install tox`

Run tests

`$ tox`

After that, go ahead and start hacking!

The `source activate datascience` command must be run each time you develop in
the package. Alternatively, you can install [direnv][direnv] to auto-load/unload
the environment.

Documentation is generated from the docstrings in the methods and is pushed online
at http://data8.org/datascience/ automatically. If you want to preview the docs
at <http://data8.org/datascience/> automatically. If you want to preview the docs
locally, use these commands:

make docs # Generates docs inside doc/ folder
Expand Down
36 changes: 36 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[tox]
envlist = py36, py37, py38
skip_missing_interpreters = true

[testenv]
deps =
pytest
pytest-cov
alabaster
babel
branca
docutils
folium==0.11.0
ipython-genutils
jinja2
jupyter
jupyter_client
markupsafe
nbval
nbconvert
nbformat
nbsphinx
plotly
pygments
snowballstemmer
sphinx
sphinx-rtd-theme


commands =
python setup.py test