Add pre-commit

.github/workflows/pre-commit-autoupdate.yaml

@@ -0,0 +1,26 @@
+name: Pre-commit auto-update
+
+on:
+  # every day at midnight
+  schedule:
+    - cron: "0 0 * * *"
+  # on demand
+  workflow_dispatch:
+
+jobs:
+  auto-update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v2
+
+      - uses: browniebroke/pre-commit-autoupdate-action@main
+
+      - uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: update/pre-commit-hooks
+          title: Update pre-commit hooks
+          commit-message: "chore: update pre-commit hooks"
+          body: Update versions of pre-commit hooks to latest version.

.github/workflows/pre-commit.yaml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/[email protected]

.github/workflows/test.yaml

@@ -52,5 +52,8 @@ jobs:
       - name: Run tests
         run: poetry run pytest --cov
 
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+      - name: Pytest coverage comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+        args: [--unsafe]
+      - id: debug-statements
+      - id: mixed-line-ending
+
+  - repo: https://github.com/pycqa/doc8
+    rev: v1.1.1
+    hooks:
+      - id: doc8
+        entry: ./scripts/run_hook.py apps/rind python -m doc8
+        exclude: ^(?!(apps/rind)).*$
+
+  ## Python
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        types: [python]
+
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black
+        types: [python]

pyproject.toml

@@ -17,7 +17,7 @@ classifiers = [
 "Bug Tracker" = "https://github.com/lightmatter/welkin-health/issues"
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.8"
 requests = "^2.28.1"
 portalocker = "^2.7.0"
 
@@ -27,6 +27,7 @@ optional = true
 [tool.poetry.group.dev.dependencies]
 black = "^22.10.0"
 isort = "^5.10.1"
+pre-commit = "^3.5.0"
 
 [tool.poetry.group.test]
 optional = true

test/test_document.py

@@ -82,7 +82,6 @@ def test_document_summary_create(client, vcr_cassette):
     reason="the bytes upload hits this issue in vcr: https://github.com/kevin1024/vcrpy/issues/660 but this test shows the correct implementation"
 )
 def test_document_summary_files_create(client, vcr_cassette):
-
     with open("test/walrus_uJGKbRm.jpeg", "rb") as f:
         files = client.DocumentSummaryFiles().create(
             patient_id="283f50d3-0840-426f-b07b-bd8e4ab76401",