Update contributing docs, Makefile and tox

Author: willprice

CONTRIBUTING.rst

@@ -16,23 +16,55 @@ Thou shalt receive cookies for your welcomed contribution.
 Development
 -----------
 
-Locally
-~~~~~~~
+1. Set up a virtual environment 
 
-Ensure you have all the development dependencies:
+   .. code:: console
 
-.. code:: bash
+       $ python3 -m venv .venv
+       $ .venv/bin/activate
 
-    $ pipenv install --dev
+2. Install package in editable mode with dependencies
 
-Install the library in *development* mode so you can test it out whilst
-developing features.
+   .. code:: console
 
-.. code:: bash
+       $ pip install ".[test,docs]" -e . 
 
-    $ python setup.py develop
+3. Run unit tests
 
-On a raspberry pi
+   .. code:: console
+
+       $ make test              # run under current python version
+
+       $ pip install tox pyenv tox-pyenv  # Install pyenv tox to run under all python versions
+       $ git clone https://github.com/momo-lab/xxenv-latest.git "$(pyenv root)"/plugins/xxenv-latest
+       $ for v in 2.7 3.4 3.5 3.6 3.7; do pyenv la test install "$v"; done
+       $ pyenv versions --base > .python-version
+       $ make test-all          # run under tox for all supported python versions
+
+4. Run integration tests (on Raspberry Pi)
+
+   .. code:: console
+
+       $ make test-integration
+
+
+5. Build docs
+
+   .. code:: console
+
+       $ make doc
+       $ make doc-serve   # run HTTP server to view docs
+
+6. Run examples
+
+   .. code:: console
+
+       $ cd examples
+       $ PYTHONPATH=.. python3 video_file.py
+       $ PYTHONPATH=.. python3 advanced_usage.py
+
+
+On a Raspberry Pi
 ~~~~~~~~~~~~~~~~~
 
 There's also an Ansible playbook in ``devenv`` which will set up a

Makefile

@@ -1,5 +1,5 @@
-PYTHON2:=python2
-PYTHON3:=python3
+PYTHON2 ?= python2
+PYTHON3 ?= python3
 
 .PHONY: init
 init:
@@ -9,14 +9,17 @@ init:
 test:
 	pytest tests/unit --cov-branch --cov=omxplayer
 
-.PHONY: test
+.PHONY: test-all
 test-all:
 	tox
 
+.PHONY: test-integration
+test-integration:
+	pytest tests/integration/test.py
+
 .PHONY: dist
 dist:
-	$(PYTHON3) setup.py sdist
-	$(PYTHON3) setup.py bdist_wheel --universal
+	$(PYTHON3) setup.py sdist bdist_wheel --universal
 
 dist-upload: clean dist
 	twine upload dist/*

setup.py

@@ -70,7 +70,6 @@
 
     packages=find_packages(exclude=['*test*']),
     install_requires=lib_deps,
-    test_requires=test_deps,
     extras_require={
         'test': test_deps,
         'docs': doc_deps

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27, py34, py35, py36
+envlist = py27, py35, py36, py37
 
 [testenv]
 # Necessary for tox and pipenv to play nicely together