Merge pull request #68 from all3fox/config-tox

Use `tox` to run unit-tests

Author: pombredanne

.gitignore

@@ -1,6 +1,7 @@
 *.pyc
 /boolean.py.egg-info/
 /build/
+/.tox/
 /dist/
 /tmp/
 /.cache/

.travis.yml

@@ -6,6 +6,7 @@ python:
   - "2.7"
   - "3.4"
   - "3.5"
+  - "3.6"
 
 install:
     - pip install --upgrade pip

README.md

@@ -38,13 +38,30 @@ Documentation
 
 http://readthedocs.org/docs/booleanpy/en/latest/
 
+Installation
+------------
 
+`pip install boolean.py`
 
-Download and installation
--------------------------
+Testing
+-------
+
+Test `boolean.py` with your current Python environment:
+
+`python setup.py test`
 
-    `pip install boolean.py`
+Test with all of the supported Python environments using `tox`:
 
+```
+pip install -r test-requirements.txt
+tox
+```
+
+If `tox` throws `InterpreterNotFound`, limit it to python interpreters that are actually installed on your machine:
+
+```
+tox -e py27,py36
+```
 
 License
 -------

docs/development_guide.rst

@@ -10,6 +10,28 @@ and laws are stated in :doc:`concepts`.
     :depth: 2
     :backlinks: top
 
+Testing
+-------
+
+Test `boolean.py` with your current Python environment:
+
+.. code-block:: shell
+
+   python setup.py test
+
+Test with all of the supported Python environments using `tox`:
+
+.. code-block:: shell
+
+   pip install -r test-requirements.txt
+   tox
+
+If `tox` throws `InterpreterNotFound`, limit it to python interpreters that are actually installed on your machine:
+
+.. code-block:: shell
+
+   tox -e py27,py36
+
 Classes Hierarchy
 -----------------
 ..

docs/users_guide.rst

@@ -25,9 +25,10 @@ Other compositions like XOR and NAND are not implemented.
 
 Installation
 ------------
-::
-    pip install boolean.py
 
+.. code-block:: sh
+
+   pip install boolean.py
 
 Creating boolean expressions
 ----------------------------
@@ -39,7 +40,7 @@ an algebra, then use algebra attributes and methods to build expressions.
 You can build an expression from a string:
 
 .. doctest:: boolean
-    
+
     >>> import boolean
     >>> algebra = boolean.BooleanAlgebra()
     >>> algebra.parse('x & y')
@@ -59,7 +60,7 @@ You can build an expression from a Python expression:
     >>> x & y
     AND(Symbol('x'), Symbol('y'))
 
-You can build an expression by using the algebra functions::
+You can build an expression by using the algebra functions:
 
 .. doctest:: boolean
 
@@ -254,9 +255,9 @@ Using boolean.py to define your own boolean algebra
 ---------------------------------------------------
 
 You can customize about everything in boolean.py to create your own custom algebra:
-1. You can subclass :class:`BooleanAlgebra` and override or extend the 
-:meth:`tokenize`:: and :meth:`parse`:: method to parse custom expression creating
-your own mini expression language. Seen the tests for examples.
+1. You can subclass :class:`BooleanAlgebra` and override or extend the
+:meth:`tokenize` and :meth:`parse` methods to parse custom expressions creating
+your own mini expression language. See the tests for examples.
 
 2. You can subclass the Symbol, NOT, AND and OR functions to add additional 
 methods or for custom representations.

test-requirements.txt

@@ -0,0 +1 @@
+tox=2.7.0

tox.ini

@@ -0,0 +1,4 @@
+[tox]
+envlist=py27,py36
+[testenv]
+commands=python setup.py test