Skip to content

Commit

Permalink
Document test execution, and match Tox Python versions to setup.py's …
Browse files Browse the repository at this point in the history
…versions
  • Loading branch information
mileswwatkins committed Apr 8, 2019
1 parent 03922cf commit 15165f4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,23 @@ When you need to know state information RIGHT AWAY, there's the *states* script.
block: http://www2.census.gov/geo/tiger/TIGER2010/TABBLOCK/2010/tl_2010_24_tabblock10.zip


Running Tests
-------------

CircleCI is set up to automatically run unit tests against any new commits to
the repo. To run these tests yourself in a standardized, Dockerized
environment, install
`the CircleCI CLI <https://circleci.com/docs/2.0/local-cli/>`_, and then
execute the tests with: ::

circleci local execute --job build

Alternatively, you can run tests against only your current version of Python,
using: ::

pytest tests


Contributing
------------

Expand All @@ -194,6 +211,7 @@ Any changes other than additions to *data.db* should come with appropriate
tests in *test.py*. Also check to see if the *states* CLI script should be
modified to accommodate your change.


Changelog
---------

Expand Down
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[tox]
envlist = py27,py37
# Mirror the Python versions listed in `setup.py`
envlist = py27,py34,py35,py36,py37

[testenv]
deps = -rrequirements.txt
Expand Down

0 comments on commit 15165f4

Please sign in to comment.