Add a linter workflow

.cspell.json

@@ -0,0 +1,15 @@
+{
+    "version": "0.2",
+    "language": "en",
+    "dictionaries": ["en-gb", "companies", "softwareTerms", "misc", "python", "bash", "filetypes"],
+    "words": [
+        "Kenney",
+        "commandline",
+        "pyproject",
+        "pydantic",
+        "pipx"
+    ],
+    "ignorePaths": [
+        ".gitignore"
+    ]
+}

.github/dependabot.yml

@@ -2,10 +2,10 @@
 # package ecosystems to update and where the package manifests are located.
 # Please see the documentation for all configuration options:
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
+---
 version: 2
 updates:
-  - package-ecosystem: "poetry" # See documentation for possible values
+  - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"

.github/workflows/build-and-publish.yml

@@ -1,3 +1,5 @@
+---
+# cspell: ignore marvinpinto, pypa
 name: Build and publish
 
 on:
@@ -34,12 +36,15 @@ jobs:
 
       - run: poetry install
 
-      - run: PKG_VERSION=$(poetry version --short) && echo $PKG_VERSION && echo "value=$PKG_VERSION" >> $GITHUB_OUTPUT
+      - run: |
+          PKG_VERSION=$(poetry version --short) && \
+          echo "$PKG_VERSION" && \
+          echo "value=$PKG_VERSION" >> "$GITHUB_OUTPUT"
         id: pkg_version
 
       - run: poetry build
-
-      - run: echo "value=$(ls dist/*.tar.gz | sed 's/.tar.gz//' | xargs basename)" >> $GITHUB_OUTPUT
+        # shellcheck disable=SC2012
+      - run: echo "value=$(ls dist/*.tar.gz | sed 's/.tar.gz//' | xargs basename)" >> "$GITHUB_OUTPUT"
         id: dist_folder
 
       - name: Publish distribution to GitHub
@@ -54,4 +59,4 @@ jobs:
         uses: pypa/gh-action-pypi-publish@master
         with:
           user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/install-package.yml

@@ -1,3 +1,4 @@
+---
 name: Install package
 
 on:
@@ -38,4 +39,3 @@ jobs:
       - run: poetry install
 
       - run: poetry version
-

.github/workflows/on-pr-lint.yml

@@ -0,0 +1,16 @@
+---
+# cspell: ignore nvuillam
+
+name: Lint on Pull Request
+on:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: nvuillam/mega-linter@v6
+        with:
+          PYTHON_MYPY_DISABLE_ERRORS: true

README.md

@@ -76,7 +76,7 @@ requests = { version = "^2.28.2", optional = true } # Package added as optional
 
 [tool.poetry.extras]
 #...existing extras...
-web = ["requesets"] # A new extra 'web'
+web = ["requests"] # A new extra 'web'
 ```
 
 ### Build package

coder_dojo_common/models.py

@@ -5,7 +5,7 @@
 import json
 from datetime import datetime, timedelta
 from pathlib import Path
-from typing import Optional, Union, Iterator
+from typing import Iterator, Optional, Union
 
 from pydantic import BaseModel
 from requests import Session

coder_dojo_common/settings.py

@@ -9,7 +9,7 @@ class CoderDojoSettings(BaseSettings):
     # Configuration
     class Config:
         """
-        Set env prefix, root values can be overriden from environment variables prefixed with CODER_DOJO_
+        Set env prefix, root values can be overridden from environment variables prefixed with CODER_DOJO_
 
         e.g.
             CODER_DOJO_ROOT_DIR=/tmp