Rewrite library

.github/workflows/draft.yml

@@ -15,18 +15,18 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install -U pip setuptools wheel
+          pip install -e .[test]
       - name: Test with pytest
         run: |
-          python3 -m pytest -vv -s
+          pytest -vv -s
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
@@ -36,4 +36,4 @@ jobs:
           tag_name: ${{ github.ref }}
           release_name: ${{ github.ref }}
           draft: true
-          prerelease: false
+          prerelease: false

.github/workflows/pr.yml

@@ -2,28 +2,80 @@ name: Pull Request & Push to Master Branch
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      master
   pull_request:
-    branches: [ master ]
+    branches:
+      master
+  workflow_dispatch:
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install -U pip setuptools wheel
+          pip install .[test]
+          pip install pre-commit
+      - name: Run pre-commit
+        run: |
+          pre-commit install
+          # python<3.7 uses older flake8 version, that reports errors on decorator line
+          # instead of def line. We cannot satisfy both, just ignore legacy and old.
+          if [ $(python -V | cut -d. -f2) -le 7 ]
+          then
+            SKIP="pytest,pyproject-flake8" pre-commit run --all-files -v
+          else
+            SKIP="pytest" pre-commit run --all-files -v
+          fi;
 
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+      fail-fast: false
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Test with pytest
+          pip install -U pip setuptools wheel
+          pip install .[test]
+      - name: Run pytest
+        run: |
+          pytest -vv -s
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          pip install -U pip setuptools wheel
+          pip install -e .[docs]
+      - name: Make docs
         run: |
-          python3 -m pytest -vv -s
+          cd docs
+          make clean html
+          sphinx-build -b linkcheck source build/linkcheck

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-merge-conflict
+    -   id: check-toml
+    -   id: check-yaml
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.9.3
+    hooks:
+      - id: isort
+        name: isort
+        args: ["--profile", "black"]
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+-   repo: https://github.com/csachs/pyproject-flake8
+    rev: v0.0.1a4
+    hooks:
+      - id: pyproject-flake8
+        name: flake8
+        additional_dependencies: [
+          'flake8-docstrings',
+          'flake8-rst-docstrings',
+          'flake8-2020',
+          'flake8-alfred',
+          'flake8-broken-line',
+          'flake8-bugbear',
+          'flake8-builtins',
+          'flake8-debugger',
+          'flake8-noqa',
+          'flake8-pep3101',
+          'flake8-pie',
+          'flake8-pytest',
+          'flake8-pytest-style',
+          'flake8-simplify',
+          'pep8-naming',
+        ]
+-   repo: local
+    hooks:
+      # We could use mypy-mirror, but it has some unconvenient limitations.
+      - id: doctest
+        name: doctest
+        entry: python -m doctest
+        language: system
+        files: "README.md"
+      - id: mypy
+        name: mypy
+        entry: mypy --config=pyproject.toml --cache-dir=/dev/null --no-incremental
+        language: system
+        types: [ python ]
+        exclude: "docs/*"
+      - id: pytest
+        name: pytest
+        entry: pytest -vv -s
+        language: system
+        types: [ python ]
+        pass_filenames: false
+        exclude: "setup.py"
+        always_run: true

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+  apt_packages:
+    - graphviz
+
+sphinx:
+   configuration: docs/source/conf.py
+
+python:
+   install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - test

Makefile

@@ -1,11 +1,13 @@
 install:
 	python3 -m venv .env
-	. .env/bin/activate && pip3 install -r requirements.txt
+	. .env/bin/activate && python3 -m pip install -e .
+	pre-commit install
 
 test:
-	. .env/bin/activate && python3 -m pytest --cov=thor_devkit --no-cov-on-fail --cov-report=term-missing -vv -s
+	. .env/bin/activate && python3 -m pytest -vv -s
 
 publish: test
 	rm -rf dist/*
-	. .env/bin/activate && python3 setup.py sdist bdist_wheel
-	. .env/bin/activate && python3 -m twine upload dist/*
+	. .env/bin/activate \
+		&& python3 setup.py sdist bdist_wheel \
+		&& python3 -m twine upload dist/*