Python 3 refactor (#9)

* First pass

* Just work my dude

* Wheels?

* I don't understand you

* Do iiit

* Maybe you could work tho

* Will this work?

* Gzzz

* How about now?

* Do iiit

* Please

* bleep

* Exclude /docs/ from appveyor builds

* exclude -> except

* Updated meta.yaml for conda build

Author: sdrobert

.gitignore

@@ -105,4 +105,5 @@ dist/
 .pytest_cache/
 .ftpconfig
 .ftpignore
-.vscode/
+.vscode/
+version.py

.travis.yml

@@ -0,0 +1,27 @@
+# v0.2.0
+
+A considerable amount of refactoring occurred for this build, chiefly to get
+rid of Python 2.7 support. While the functionality did not change much for this
+version, we have switched from a `pkgutil`-style `pydrobert` namespace to
+PEP-420-style namespaces. As a result, *this package is not
+backwards-compatible with previous `pydrobert` packages!* Make sure that if any
+of the following are installed, they exceed the following version thresholds:
+
+- `pydrobert-param >0.2.0`
+- `pydrobert-kaldi >0.5.3`
+- `pydrobert-pytorch >0.2.1`
+
+Miscellaneous other stuff:
+
+- Type hints everywhere
+- Shifted python source to `src/`
+- Black-formatted remaining source
+- Removed `future` dependency
+- Shifted most of the configuration to `setup.cfg`, leaving only a shell
+  in `setup.py` to remain compatible with Conda builds
+- Added `pyproject.toml` for [PEP
+  517](https://www.python.org/dev/peps/pep-0517/).
+- `tox.ini` for TOX testing
+- Switched to AppVeyor for CI
+- Messed around with documentation a little bit
+- Added changelog :D

CHANGELOG.md

@@ -1,5 +1,5 @@
-[![Build Status](https://travis-ci.com/sdrobert/pydrobert-speech.svg?branch=master)](https://travis-ci.com/sdrobert/pydrobert-speech)
 [![Documentation Status](https://readthedocs.org/projects/pydrobert-speech/badge/?version=latest)](https://pydrobert-speech.readthedocs.io/en/latest/?badge=latest)
+[![Build status](https://ci.appveyor.com/api/projects/status/abn39mww84fydxqe/branch/master?svg=true)](https://ci.appveyor.com/project/sdrobert/pydrobert-speech/branch/master)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 # pydrobert-speech
@@ -36,7 +36,7 @@ feats = computer.compute_full(signal)
 
 If you plan on using a [PyTorch](https://pytorch.org) `DataLoader` or Kaldi
 tables in your ASR pipeline, you can compute all a corpus' features by
-using the commmands `signals-to-torch-feat-dir` (requires *pytorch* package)
+using the commands `signals-to-torch-feat-dir` (requires *pytorch* package)
 or `compute-feats-from-kaldi-tables` (requires *pydrobert-kaldi* package).
 
 This package can compute much more than f-banks, with many different

README.md

@@ -0,0 +1,28 @@
+version: build.{build}.branch.{branch}
+image: Visual Studio 2019
+
+environment:
+  matrix:
+    - TOXENV: py36
+      PYTHON: "C:\\Python36-x64"
+    - TOXENV: py37
+      PYTHON: "C:\\Python37-x64"
+    - TOXENV: py38
+      PYTHON: "C:\\Python38-x64"
+    - TOXENV: py39
+      PYTHON: "C:\\Python39-x64"
+
+build: off
+
+init:
+  - cmd: set PATH=%PYTHON%;%PYTHON%\Scripts;%PATH%
+
+install:
+  - python -m pip install -U pip tox wheel
+
+test_script:
+  - python -m tox
+
+branches:
+  except:
+    - /docs/

appveyor.yml

@@ -13,23 +13,21 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath("../../src"))
 
 
-autodoc_mock_imports = [
-    'numpy',
-]
+autodoc_mock_imports = ["numpy", "matplotlib"]
 
 # -- Project information -----------------------------------------------------
 
-project = 'pydrobert-speech'
-copyright = '2019, Sean Robertson'
-author = 'Sean Robertson'
+project = "pydrobert-speech"
+copyright = "2021, Sean Robertson"
+author = "Sean Robertson"
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+release = ""
 
-language = 'en'
+language = "en"
 
 
 # -- General configuration ---------------------------------------------------
@@ -38,12 +36,23 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
 ]
 
+naploeon_numpy_docstring = True
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/", None),
+    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
+    "matplotlib": ("https://matplotlib.org", None),
+}
+
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -53,19 +62,19 @@
 
 # -- Options for HTML output -------------------------------------------------
 
-on_rtd = os.environ.get('READTHEDOCS') == 'True'
+on_rtd = os.environ.get("READTHEDOCS") == "True"
 if on_rtd:
-    html_theme = 'default'
+    html_theme = "default"
 else:
-    html_theme = 'nature'
+    html_theme = "sphinx_rtd_theme"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
-highlight_language = 'none'
+highlight_language = "none"
 
-master_doc = 'index'
+master_doc = "index"

docs/source/conf.py

@@ -2,9 +2,9 @@
    :maxdepth: 2
    :caption: Contents:
 
-.. include:: overview.rst
-
-.. include:: modules.rst
+   overview
+   modules
+   references
 
 Indices and tables
 ==================

docs/source/index.rst

@@ -1,10 +1,7 @@
 pydrobert.speech package
 ========================
 
-Submodules
-----------
-
-pydrobert.speech.command\_line module
+pydrobert.speech.command_line module
 -------------------------------------
 
 .. automodule:: pydrobert.speech.command_line

docs/source/pydrobert.speech.rst

@@ -0,0 +1,24 @@
+References
+----------
+.. [stevens1937] S. S. Stevens, J. Volkmann, and E. B. Newman, "A Scale for the
+   Measurement of the Psychological Magnitude Pitch," The Journal of the
+   Acoustical Society of America, vol. 8, no. 3, pp. 185-190, 1937.
+.. [flanagan1960] J. L. Flanagan, "Models for approximating basilar membrane
+   displacement," The Bell System Technical Journal, vol. 39, no. 5, pp.
+   1163-1191, Sep. 1960.
+.. [zwicker1961] E. Zwicker, "Subdivision of the Audible Frequency Range into
+   Critical Bands (Frequenzgruppen)," The Journal of the Acoustical Society of
+   America, vol. 33, no. 2, pp. 248-248, 1961.
+.. [aertsen1981] A. M. H. J. Aertsen, J. H. J. Olders, and P. I. M. Johannesma,
+   "Spectro-temporal receptive fields of auditory neurons in the grassfrog,"
+   Biological Cybernetics, vol. 39, no. 3, pp. 195-209, Jan. 1981.
+.. [oshaughnessy1987] D. O'Shaughnessy, Speech communication: human and
+   machine. Addison-Wesley Pub. Co., 1987.
+.. [tranmuller1990] H. Traunm\\:{u}ller, "Analytical expressions for the
+   tonotopic sensory scale," The Journal of the Acoustical Society of America,
+   vol. 88, no. 1, pp. 97-100, Jul. 1990.
+.. [povey2011] D. Povey et al., "The Kaldi Speech Recognition Toolkit," in
+   IEEE 2011 Workshop on Automatic Speech Recognition and Understanding, Hilton
+   Waikoloa Village, Big Island, Hawaii, US, 2011.
+.. [young] S. Young et al., "The HTK book (for HTK version 3.4)," Cambridge
+   university engineering department, vol. 2, no. 2, pp. 2-3, 2006.