Refactor and documentation push

.github/workflows/main.yml

@@ -0,0 +1,85 @@
+name: CI
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  # Allow rebuilds via API.
+  repository_dispatch:
+    types: rebuild
+
+
+concurrency:
+  group: run_tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pre-commit:
+    name: "Pre-commit"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Locally install interrogate
+        run: python -m pip install .
+      - name: Run pre-commit
+        uses: pre-commit/action@v2.0.3
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools setuptools_scm[toml] wheel
+          pip install tox tox-gh-actions tox-conda
+      - name: Test with tox
+        run: tox
+      - name: "Upload coverage to Codecov"
+        uses: "codecov/codecov-action@v2.0.3"
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: true
+
+  package:
+    name: "Build & Verify Package on Ubuntu"
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v2"
+      - uses: "actions/setup-python@v2"
+        with:
+          python-version: "3.8"
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+      - name: "List result"
+        run: "ls -l dist"
+      - name: "Check long_description"
+        run: "python -m twine check dist/*"
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/

.gitignore

@@ -20,6 +20,7 @@ pretrained_models/
 *.so
 
 # Distribution / packaging
+montreal_forced_aligner/version.py
 .Python
 env/
 build/
@@ -76,3 +77,5 @@ target/
 *.dll
 
 \.pytest_cache/
+
+docs/source/api/

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+default_language_version:
+  python: python3.8
+repos:
+  - repo: https://github.com/psf/black
+    rev: 21.8b0
+    hooks:
+      - id: black
+  - repo: https://github.com/asottile/blacken-docs
+    rev: v1.11.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+          - black==20.8b1
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-bugbear == 20.1.4
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.9.3
+    hooks:
+      - id: isort
+        additional_dependencies: [toml]
+  - repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v1.19.0
+    hooks:
+      - id: setup-cfg-fmt
+        args:
+          - --min-py3-version
+          - "3.5"
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: check-toml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: mixed-line-ending

.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "mambaforge-4.10"
+
+sphinx:
+   configuration: docs/source/conf.py
+
+conda:
+  environment: environment.yml
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

MANIFEST.in

@@ -0,0 +1,32 @@
+include LICENSE *.md pyproject.toml *.yml *.yaml *.ini *.txt
+graft .github
+
+# Source
+recursive-include montreal_forced_aligner *.py
+recursive-include montreal_forced_aligner *.yaml
+
+# Tests
+include tox.ini tests/conftest.py
+recursive-include tests *.py
+recursive-include tests *.txt *.lab *.TextGrid
+recursive-include tests *.flac *.wav *.mp3
+recursive-include tests *.yaml
+recursive-include tests *.zip *.arpa
+recursive-include tests topo *.fst *.int
+prune tests/data/generated
+
+# Docs
+recursive-include docs *.svg
+recursive-include docs *.py
+recursive-include docs *.pdf
+recursive-include docs *.png
+recursive-include docs *.rst
+recursive-include docs *.css
+recursive-include docs *.html
+include docs/Makefile
+include docs/make.bat
+prune docs/build
+prune docs/source/generated
+
+prune dist
+prune build

docs/Makefile

@@ -57,7 +57,7 @@ diagrams:
 	sed -i '' '/^def/,/class/{/class/!d;}' ../montreal_forced_aligner/generalUML.py; sed -i '' '/^import/,/class/{/class/!d;}' ../aligner/generalUML.py
 	$(PYREVERSE) -o svg -AS -k ../montreal_forced_aligner/generalUML.py
 	mv classes.svg $(BUILDDIR)/generalUML.svg; chmod 777 $(BUILDDIR)/generalUML.svg; rm ../montreal_forced_aligner/generalUML.py
-	mv $(BUILDDIR)/generalUML.svg $(BUILDDIR)/html/_images 
+	mv $(BUILDDIR)/generalUML.svg $(BUILDDIR)/html/_images
 
 	# UML class diagram for aligner API
 	cat ../montreal_forced_aligner/aligner/pretrained.py ../montreal_forced_aligner/aligner/trainable.py ../montreal_forced_aligner/aligner/base.py > ../aligner/all_aligner.py