Merge pull request #32 from laracroft37/ci-linting

Add remaining type hints and linter checks for the project
and include a minimal mypy config file and linting workflow.

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.8, 3.9, 3.10.9, 3.11, 3.12]
+        python-version: [3.10.9, 3.11, 3.12]
         avocado-version: ["103.0"]
       fail-fast: false
 

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint Check
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mypy types-setuptools black pycodestyle pydocstyle
+
+      - name: Run linters
+        run: |
+          mypy avocado_i2n
+          black --check --diff --color avocado_i2n
+          # only excluded checks are conflicts with black and within pycodestyle
+          # (in addition E402 is not something we intend to follow)
+          pycodestyle --ignore=E203,E402,E501,W503 avocado_i2n
+          pydocstyle avocado_i2n

Makefile

@@ -16,7 +16,7 @@ all:
 	@echo
 
 check:
-	$(COVERAGE) run --source=avocado_i2n -m unittest discover -v selftests
+	$(COVERAGE) run --source=avocado_i2n -m unittest discover -v selftests/isolation
 
 install:
 	$(PYTHON) setup.py install --root $(DESTDIR)

avocado_i2n/__init__.py

@@ -0,0 +1 @@
+"""Package with the complete Avocado I2N modules and functionality."""

avocado_i2n/cartgraph/__init__.py

@@ -1,3 +1,5 @@
+"""Package for the complete Cartesian graph structure."""
+
 from .object import TestObject, NetObject, VMObject, ImageObject
 from .worker import TestEnvironment, TestSwarm, TestWorker
 from .node import PrefixTreeNode, PrefixTree, EdgeRegister, TestNode