docs: document codebase and add CI (#17)

* docs: document entire codebase * feat: add lint action * chore: improve CI * chore: fix ci * chore: apply black patch * chore: run only on pull request * chore: bump version
sralloza · Nov 6, 2021 · 2f924e2 · 2f924e2
1 parent 94d88f3
commit 2f924e2
Show file tree

Hide file tree

Showing 34 changed files with 907 additions and 35 deletions.
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -0,0 +1,38 @@
+name: Linter
+
+on:
+  pull_request:
+  release:
+
+jobs:
+  linter:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+        poetry-version: [1.1.11]
+        os: [ubuntu-18.04]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+
+      - name: Install
+        run: poetry install
+
+      - name: Run black
+        run: poetry run black --check app
+
+      - name: Check imports
+        run: poetry run isort --check app
+
+      - name: Lint with pylint
+        run: poetry run pylint app