Complete overhaul

.coveragerc

@@ -0,0 +1,5 @@
+[report]
+exclude_lines =
+    pragma: nocover
+    if TYPE_CHECKING:
+    @abstractmethod

.flake8

@@ -0,0 +1,15 @@
+[flake8]
+max_line_length=120
+extend-ignore=E203 # flake8 has conflicting handling with black here
+application-import-names=zerocom,tests
+exclude=.venv,.git,.cache
+ignore=
+    ANN002, # *args
+    ANN003, # **kwargs
+    ANN101, # self param annotation
+    ANN102, # cls param annotation
+    ANN204, # return type annotation for special methods
+
+    E731,  # Allow inline lambdas
+    MD033, # Allow inline HTML in markdown
+per-file-ignores=*/__init__.py:F401,test_*.py:ANN

.github/workflows/unit-tests.yml

@@ -0,0 +1,85 @@
+name: Unit-Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+# Cancel already running workflows if new ones are scheduled
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Make sure pip caches dependencies and installs as user
+  PIP_NO_CACHE_DIR: false
+  PIP_USER: 1
+
+  # Make sure poetry won't use virtual environments
+  POETRY_VIRTUALENVS_CREATE: false
+
+  # Specify paths here, so we know what to cache
+  POETRY_CACHE_DIR: ${{ github.workspace }}/.cache/py-user-base
+  PYTHONUSERBASE: ${{ github.workspace }}/.cache/py-user-base
+
+jobs:
+  unit-tests:
+    runs-on: ${{ matrix.platform }}
+
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.7", "3.10"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        id: python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Add custom PYTHONUSERBASE to PATH (linux)
+        if: runner.os != 'Windows'
+        run: echo '${{ env.PYTHONUSERBASE }}/bin/' >> $GITHUB_PATH
+
+      # Windows is an absolute piece of crap, for some reason, instead of using /bin
+      # dir in the userbase path, it creates additional folder named differently in each version
+      # in which it makes Scripts/ folder (i.e. USERBASE/Python37/Scripts). To handle this
+      # we're using python's site module which can output it's own path, getting the dirname
+      # and adding /Scripts as a suffix which is then added to the path.
+      - name: Add custom PYTHONUSERBASE to PATH (windows)
+        if: runner.os == 'Windows'
+        run: |
+          dir="$(dirname $(python3 -m site --user-site))\\Scripts"
+          echo "$dir" >> $GITHUB_PATH
+          cat "$GITHUB_PATH"
+        shell: bash
+
+      # Cache python dependencies so that unless we change them,
+      # we won't need to reinstall them with each workflow run.
+      # The key is a composite of multiple values, which when changed
+      # the cache won't be restored in order to make updating possible
+      - name: Python dependency caching
+        uses: actions/cache@v2
+        id: python_cache
+        with:
+          path: ${{ env.PYTHONUSERBASE }}
+          key: "python-0-${{ runner.os }}-${{ env.PYTHONUSERBASE }}-\
+                ${{ steps.python.outputs.python-version }}-\
+                ${{ hashFiles('./pyproject.toml', './poetry.lock') }}"
+
+      # In case the dependencies weren't restored, install them
+      - name: Install dependencies using poetry
+        if: steps.python_cache.outputs.cache-hit != 'true'
+        run: |
+          pip install poetry
+          poetry install
+
+      # Run the unit-tests using pytest
+      - name: Run pytest
+        run: poetry run task test

.github/workflows/validation.yml

@@ -0,0 +1,92 @@
+name: Validation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+# Cancel already running workflows if new ones are scheduled
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Make sure pip caches dependencies and installs as user
+  PIP_NO_CACHE_DIR: false
+  PIP_USER: 1
+
+  # Make sure poetry won't use virtual environments
+  POETRY_VIRTUALENVS_CREATE: false
+
+  # Specify paths here, so we know what to cache
+  POETRY_CACHE_DIR: ${{ github.workspace }}/.cache/py-user-base
+  PYTHONUSERBASE: ${{ github.workspace }}/.cache/py-user-base
+  PRE_COMMIT_HOME: ${{ github.workspace }}/.cache/pre-commit-cache
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Add custom PYTHONUSERBASE to PATH
+        run: echo '${{ env.PYTHONUSERBASE }}/bin/' >> $GITHUB_PATH
+
+      - name: Set up Python
+        id: python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10.4"
+
+      # Cache python dependencies so that unless we change them,
+      # we won't need to reinstall them with each workflow run.
+      # The key is a composite of multiple values, which when changed
+      # the cache won't be restored in order to make updating possible
+      - name: Python dependency caching
+        uses: actions/cache@v2
+        id: python_cache
+        with:
+          path: ${{ env.PYTHONUSERBASE }}
+          key: "python-0-${{ runner.os }}-${{ env.PYTHONUSERBASE }}-\
+                ${{ steps.python.outputs.python-version }}-\
+                ${{ hashFiles('./pyproject.toml', './poetry.lock') }}"
+
+      # In case the dependencies weren't restored, install them
+      - name: Install dependencies using poetry
+        if: steps.python_cache.outputs.cache-hit != 'true'
+        run: |
+          pip install poetry
+          poetry install
+
+      # Cache pre-commit environment
+      # The key is a composite of multiple values, which when changed
+      # the cache won't be restored in order to make updating possible
+      - name: Pre-commit Environment Caching
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.PRE_COMMIT_HOME }}
+          key: "precommit-0-${{ runner.os }}-${{ env.PRE_COMMIT_HOME }}-\
+                ${{ steps.python.outputs.python-version }}-\
+                ${{ hashFiles('./.pre-commit-config.yaml') }}"
+
+      # Run the actual linting steps here:
+
+      # We skip the major hooks here, because we want to see their output, and
+      # success status separately in another task. They are ran below.
+      - name: Run general pre-commit hooks
+        run: PIP_USER=0; SKIP=flake8,black,isort,pyright pre-commit run --all-files
+
+      - name: Run flake8 linter
+        run: flake8 .
+
+      - name: Run black formatter (check)
+        run: black --check .
+
+      - name: Run isort import formatter (check)
+        run: isort --check .
+
+      - name: Run pyright type checker
+        run: pyright -v $PYTHONUSERBASE

.gitignore

@@ -1,28 +1,36 @@
-# Python cache
+# Python byte-compiled / optimized / DLL files
 __pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Pytest coverage reports
+.coverage
+htmlcov/
 
 # Editor generated files
 .idea/
 .vscode/
 .spyproject/
-
-# VirtualENV files
-env/
-venv/
-.venv/
+.vimrc
+.nvimrc
+.exerc
 
 # Environmental and personal files
 *.env
 TODO
 
-# Database files
-*.sqlite3
-*.sqlite
-*.sql
-*.db
+# Local gitignore (symlinked to .git/info/exclude)
+.gitignore_local
 
-# Ignore personal log files
+# Ignore generated log files
 logs/
 
-# MacOS generatd file
+# Auto-generated folder attributes for MacOS
 .DS_STORE

.pre-commit-config.yaml

@@ -3,7 +3,8 @@ repos:
     rev: v4.0.1
     hooks:
       - id: check-merge-conflict
-      - id: check-toml
+      - id: check-toml # For pyproject.toml
+      - id: check-yaml # For workflows
       - id: end-of-file-fixer
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
@@ -13,14 +14,42 @@ repos:
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.9.0
     hooks:
-      - id: python-check-blanket-noqa
-      - id: python-use-type-annotations
+      - id: python-check-blanket-noqa # Enforce specific noqa annotations (noqa: F401,W203)
+      - id: python-use-type-annotations # Enforce type annotations instead of type comments
+
+  - repo: local
+    hooks:
+      - id: black
+        name: Black
+        description: Auto-format the code with black
+        entry: poetry run black
+        language: system
+        types: [python]
+
+  - repo: local
+    hooks:
+      - id: isort
+        name: ISort
+        description: Sort imports with isort
+        entry: poetry run isort
+        language: system
+        types: [python]
 
   - repo: local
     hooks:
       - id: flake8
         name: Flake8
         description: Run flake8 checks on the code
-        entry: pipenv run flake8
+        entry: poetry run flake8
+        language: system
+        types: [python]
+
+  - repo: local
+    hooks:
+      - id: pyright
+        name: Pyright
+        description: Run pyright type checker
+        entry: poetry run pyright
         language: system
         types: [python]
+        pass_filenames: false # pyright runs for the entire project, it can't run for single files