Add tox configuration; perform clean-up needed for tox to pass

CHANGELOG.rst

@@ -1,7 +1,7 @@
 Changelog
 =========
 
-0.1.0 (not yet released)
-------------------------
+0.1.0 (under development)
+-------------------------
 
 -   Initial release.

MANIFEST.in

@@ -0,0 +1,22 @@
+graft docs
+graft examples
+graft tests
+
+include .bumpversion.cfg
+include .coveragerc
+include .cookiecutterrc
+include .editorconfig
+include .isort.cfg
+
+include AUTHORS.rst
+include CHANGELOG.rst
+include CONTRIBUTING.rst
+include LICENSE
+include README.rst
+
+include tox.ini .travis.yml appveyor.yml
+
+global-exclude *.py[cod] __pycache__ *.so *.dylib
+
+include *.txt
+recursive-include requirements *.txt

README.rst

@@ -1,10 +1,26 @@
-Overview of Metrasynth Orbitant
-===============================
+Overview of Orbitant
+====================
 
 ..  start-badges
 
+|buildstatus| |docs|
+
+.. |buildstatus| image:: https://img.shields.io/travis/metrasynth/orbitant.svg?style=flat
+    :alt: build status
+    :scale: 100%
+    :target: https://travis-ci.org/metrasynth/orbitant
+
+.. |docs| image:: https://readthedocs.org/projects/orbitant/badge/?version=latest
+    :alt: Documentation Status
+    :scale: 100%
+    :target: https://orbitant.readthedocs.io/en/latest/?badge=latest
+
 ..  end-badges
 
+Part of the Metrasynth_ project.
+
+.. _Metrasynth: https://metrasynth.github.io/
+
 
 Purpose
 -------

docs/conf.py

@@ -36,6 +36,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
+    'plantweb.directive',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/license.rst

@@ -0,0 +1 @@
+.. include:: ../LICENSE

docs/requirements.txt

@@ -0,0 +1,8 @@
+plantweb
+sphinx>=1.3
+sphinx-rtd-theme
+
+git+https://github.com/metrasynth/radiant-voices
+git+https://github.com/metrasynth/sunvox-dll-python
+
+-e .

orbitant/tools/generator.py

@@ -12,7 +12,7 @@ def main(bpm: 'Beats per Minute' = 120,
          name: 'MIDI port name' = 'Orbitant Generator',
          ):
     bpm = int(bpm)
-    tpn = int(tpb)
+    tpb = int(tpb)
     port = backend.open_output(name=name, virtual=True)
     gen = generator.Generator(port=port, bpm=bpm, tpb=tpb)
     logging.info('Starting clock; press ^C to exit')

orbitant/transport.py

@@ -17,12 +17,15 @@
 
 
 def beat_properties(ticks):
+
     @property
     def beat(self):
         return self.tick // ticks
+
     @property
     def beat_tick(self):
         return self.tick % ticks
+
     return beat, beat_tick
 
 
@@ -106,16 +109,29 @@ def _increment_tick(self):
 
     # Override these in subclasses:
     def on_start(self): pass
+
     def on_stop(self): pass
+
     def on_continue(self): pass
+
     def on_rewind(self): pass
+
     def on_tick(self): pass
+
     def on_midi_beat(self): pass
+
     def on_32nd(self): pass
+
     def on_sextuplet(self): pass
+
     def on_16th(self): pass
+
     def on_triplet(self): pass
+
     def on_8th(self): pass
+
     def on_quarter(self): pass
+
     def on_half(self): pass
+
     def on_whole(self): pass

setup.py

@@ -3,12 +3,12 @@
 import io
 import os
 import re
-from setuptools import find_packages, setup
 import sys
+from setuptools import find_packages, setup
 
 SETUP_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__)))
 sys.path.append(SETUP_DIR)
-import orbitant
+import orbitant  # NOQA isort:skip
 
 dependencies = [
     'begins',
@@ -33,7 +33,8 @@ def read(*names, **kwargs):
     author_email='matt@11craft.com',
     description=__doc__,
     long_description='%s\n%s' % (
-        re.compile('^.. start-badges.*^.. end-badges', re.M | re.S).sub('', read('README.rst')),
+        re.compile('^.. start-badges.*^.. end-badges', re.M | re.S).
+            sub('', read('README.rst')),
         re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst'))
     ),
     packages=find_packages(exclude=['docs', 'tests']),

tox.ini

@@ -0,0 +1,106 @@
+; a generative tox configuration, see: https://testrun.org/tox/latest/config.html#generative-envlist
+
+[tox]
+envlist =
+    clean,
+    check,
+    py35,
+    report,
+    docs
+
+[testenv]
+basepython =
+    pypy: {env:TOXPYTHON:pypy}
+    {py35,docs,spell}: {env:TOXPYTHON:python3.5}
+    {clean,check,report,coveralls,codecov}: python3.5
+    bootstrap: python
+setenv =
+    PYTHONPATH={toxinidir}/tests
+    PYTHONUNBUFFERED=yes
+passenv =
+    *
+usedevelop = false
+deps =
+    pytest
+    pytest-travis-fold
+    pytest-cov
+commands =
+    {posargs:py.test --cov --cov-report=term-missing -vv tests}
+
+[testenv:bootstrap]
+deps =
+    jinja2
+    matrix
+skip_install = true
+commands =
+    python ci/bootstrap.py
+passenv =
+    *
+
+[testenv:spell]
+setenv =
+    SPELLCHECK=1
+commands =
+    sphinx-build -b spelling docs dist/docs
+skip_install = true
+deps =
+    -r{toxinidir}/docs/requirements.txt
+    sphinxcontrib-spelling
+    pyenchant
+
+[testenv:docs]
+deps =
+    -r{toxinidir}/docs/requirements.txt
+commands =
+    sphinx-build {posargs:-E} -b html docs dist/docs
+;; Temporarily disable until projects are published.
+;    sphinx-build -b linkcheck docs dist/docs
+
+[testenv:check]
+deps =
+    docutils
+    check-manifest
+    flake8
+    readme-renderer
+    pygments
+    isort
+skip_install = true
+commands =
+    python setup.py check --strict --metadata --restructuredtext
+    check-manifest {toxinidir}
+    flake8 orbitant tests setup.py
+    isort --verbose --check-only --diff --recursive orbitant tests setup.py
+
+[testenv:coveralls]
+deps =
+    coveralls
+skip_install = true
+commands =
+    coverage combine --append
+    coverage report
+    coveralls []
+
+[testenv:codecov]
+deps =
+    codecov
+skip_install = true
+commands =
+    coverage combine --append
+    coverage report
+    coverage xml --ignore-errors
+    codecov []
+
+
+[testenv:report]
+deps = coverage
+skip_install = true
+commands =
+    coverage combine --append
+    coverage report
+    coverage html
+
+[testenv:clean]
+commands = coverage erase
+skip_install = true
+deps = coverage
+