MRG: #224 from vocalpy/add-fix-linting

Add / fix linting

.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+name: lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: psf/black@stable
+        with:
+          options: "--line-length=120"
+          src: "./src"
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: install libsndfile1 on ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt install libsndfile1
+      - name: install
+        run: |
+          pip install nox
+          pip install '.[dev]'
+      - name: isort lint
+        uses: isort/isort-action@master
+        with:
+          configuration: "./src"
+      - name: flake8 lint
+        uses: py-actions/flake8@v2
+        with:
+          max-line-length: "120"
+          path: "./src"
+          exclude: "./src/crowsetta/_vendor"

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: "v4.4.0"
+  hooks:
+    - id: check-added-large-files
+    - id: check-case-conflict
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-yaml
+    - id: debug-statements
+    - id: end-of-file-fixer
+    - id: mixed-line-ending
+    - id: name-tests-test
+      args: ["--pytest-test-first"]
+    - id: requirements-txt-fixer
+    - id: trailing-whitespace
+
+# Autoremoves unused imports
+- repo: https://github.com/hadialqattan/pycln
+  rev: v1.1.0
+  hooks:
+  - id: pycln
+    args: [--config=pyproject.toml]
+    files: ^src/|^tests/
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort (python)
+    files: ^src/|^tests/
+
+- repo: https://github.com/psf/black
+  rev: 23.1.0
+  hooks:
+  - id: black
+    args:
+      - --line-length=120
+    files: ^src/|^tests/
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 4.0.1
+  hooks:
+  - id: flake8
+    args:
+      - "--max-line-length=120"
+    files: ^src/|^tests/
+    additional_dependencies: &flake8-dependencies
+    - flake8-bugbear

noxfile.py

@@ -50,13 +50,22 @@ def dev(session: nox.Session) -> None:
     session.run(python, "-m", "pip", "install", "-e", ".[dev,test,doc]", external=True)
 
 
+@nox.session
+def lint(session):
+    """
+    Run the linter.
+    """
+    session.install("pre-commit")
+    session.run("pre-commit", "run", "--all-files", *session.posargs)
+
+
 @nox.session
 def test(session) -> None:
     """
     Run the unit and regular tests.
     """
     session.install(".[test]")
-    session.run("pytest", *session.posargs)
+    session.run("pytest", "-n", "auto", *session.posargs)
 
 
 @nox.session
@@ -66,7 +75,7 @@ def coverage(session) -> None:
     """
     session.install(".[test]", "pytest-cov")
     session.run(
-        "pytest", "--cov=./", "--cov-report=xml", *session.posargs
+        "pytest", "-n", "auto", "--cov=./", "--cov-report=xml", *session.posargs
     )
 
 

pyproject.toml

@@ -38,7 +38,8 @@ classifiers = [
 [project.optional-dependencies]
 test = [
     "pytest >=6.2.1",
-    "pytest-cov >=2.12.0"
+    "pytest-cov >=2.12.0",
+    "pytest-xdist >=3.2.0",
 ]
 doc = [
     "ipython != 8.7.0",
@@ -58,7 +59,12 @@ doc = [
     "sphinx-tabs >= 3.3.1",
 ]
 dev = [
+    'black >=23.1.0',
+    'crowsetta[doc, test]',
+    'flake8 >=6.0.0',
     'flit',
+    'isort >=5.12.0',
+    'pycln >=2.1.3',
     'twine',
 ]
 

src/crowsetta/__init__.py

@@ -1,3 +1,4 @@
+from . import data, interface, typing, validation
 from .__about__ import (
     __author__,
     __commit__,
@@ -9,22 +10,38 @@
     __uri__,
     __version__,
 )
-
-# --- need to import everything used by formats before importing formats
-# to avoid circular import errors
-from . import (
-    data,
-    interface,
-    typing,
-    validation
-)
-
+from .annotation import Annotation
 from .bbox import BBox
-from .transcriber import Transcriber
 from .segment import Segment
 from .sequence import Sequence
-from .annotation import Annotation
+from .transcriber import Transcriber
 
-# ok, now it's safe to import formats
+# Need to import formats last to avoid circular import errors
+# isort: off
 from . import formats
 from .formats import register_format
+
+# isort: on
+
+__all__ = [
+    "__author__",
+    "__commit__",
+    "__copyright__",
+    "__email__",
+    "__license__",
+    "__summary__",
+    "__title__",
+    "__uri__",
+    "__version__",
+    "Annotation",
+    "BBox",
+    "data",
+    "formats",
+    "interface",
+    "register_format",
+    "Segment",
+    "Sequence",
+    "Transcriber",
+    "typing",
+    "validation",
+]

src/crowsetta/_vendor/textgrid/__init__.py

@@ -1 +1 @@
-from .textgrid import TextGrid, MLF, IntervalTier, PointTier, Interval, Point
+from .textgrid import MLF, Interval, IntervalTier, Point, PointTier, TextGrid

src/crowsetta/_vendor/textgrid/exceptions.py

@@ -1,3 +1,2 @@
-
 class TextGridError(Exception):
-    pass
+    pass