Check code on every push (#14)

Co-authored-by: Eric Lopes <nullhack@users.noreply.github.com>
Reviewed-on: https://gitea.eol.myds.me/cluster-projects/python-project-template/pulls/14

Author: Eric Lopes

.github/workflows/check-code.yaml

@@ -0,0 +1,28 @@
+name: Check Code standards
+
+on:
+  push:
+
+jobs:
+  set-up-docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Install ruff and cookiecutter
+        run: |
+          apt update && apt install -y python3-pip && pip install ruff cookiecutter
+      -
+        name: run cookiecutter
+        run: |
+          cookiecutter . --no-input
+      -
+        name: lint tests
+        run: |
+          cd python-project-example
+          echo 'Code check tests:'
+          ruff check
+          echo 'Code format tests:'
+          ruff format --diff

.github/workflows/release-docker-image.yaml

@@ -0,0 +1,37 @@
+
+name: Release Docker Image CI/CD
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  set-up-docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Install docker
+        run: apt update && apt install -y docker-compose
+      -
+        name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ vars.DOCKER_REGISTRY_URL }}
+          username: ${{ secrets.DOCKER_REGISTRY_USERNAME }}
+          password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      -
+        name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ vars.DOCKER_REGISTRY_URL }}/${{ github.event.repository.name }}:${{ github.ref_name }}
+

{{cookiecutter.project_slug}}/.github/workflows/check-code.yaml

@@ -12,16 +12,16 @@ jobs:
         name: Checkout
         uses: actions/checkout@v4
       -
-        name: Install ruff and black
+        name: Install ruff
         run: |
           python -m pip install --upgrade pip
-          pip install black ruff
+          pip install ruff
       -
         name: run ruff
         run: |
           ruff check **/*.py
       -
-        name: run poetry
+        name: run ruff format
         run: |
-          black **/*.py
+          ruff format **/*.py
 {% endraw %}

{{cookiecutter.project_slug}}/docs/docs/reference.md

@@ -0,0 +1 @@
+::: {{cookiecutter.package_name}}

{{cookiecutter.project_slug}}/docs/docs/tests.md

@@ -0,0 +1 @@
+::: tests

{{cookiecutter.project_slug}}/docs/mkdocs.yaml

@@ -8,7 +8,15 @@ repo_url: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.pro
 
 plugins:
   - search
-  - mkapi
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_submodules: true
+            show_if_no_docstring: true
+            modernize_annotations: true
+            separate_signature: true
+            docstring_section_style: list
   - awesome-pages
   - gen-files:
       scripts:
@@ -21,17 +29,7 @@ theme:
     scheme: default
     primary: blue
     accent: amber
-    toggle:
-      icon: material/lightbulb-outline
-      name: Switch to light mode
-  - media: '(prefers-color-scheme: dark)'
-    scheme: slate
-    primary: black
-    accent: amber
-    toggle:
-      icon: material/lightbulb
-      name: Switch to dark mode
-  features:
+  atures:
   - search.suggest
   - search.highlight
   - content.tabs.link
@@ -41,11 +39,9 @@ theme:
   #favicon: img/favicon.png
   language: en
 
-
 nav:
   - index.md
   - ... | glob=readme.md
+  - reference.md
   - ... | regex=scenarios/.+.md
-  - API: mkapi/api/{{cookiecutter.package_name}}
-  - Tests: mkapi/tests/tests
-
+  - tests.md

{{cookiecutter.project_slug}}/poetry.lock

@@ -13,25 +13,24 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.11"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^2.18.1"
-black = {version = "^22.3.0", allow-prereleases = true}
 xdoctest = "^1.0.0"
 poethepoet = "^0.16.4"
-ruff = "^0.0.253"
-pytest = "7.1.1"
-pytest-html = "^3.1.1"
-pytest-sugar = "^0.9.6"
-pytest-reverse = "^1.5.0"
-pytest-cov = "^3.0.0"
-pytest-bdd = "^6.1.1"
-mkdocs = "^1.4.2"
-mkdocs-material = "^8.5.10"
-mkdocs-gen-files = "^0.4.0"
-mkdocs-awesome-pages-plugin = "^2.8.0"
-mkapi = "^1.0.14"
+ruff = ">=0.1.7"
+pytest = ">=7.1.1"
+pytest-html = ">=4.1.0"
+pytest-sugar = ">=0.9.6"
+pytest-cov = ">=5.0.0"
+pytest-xdist = ">=3.6.1"
+pytest-bdd = ">=7.1.2"
+mkdocs = ">=1.6.0"
+mkdocs-material = ">=9.5.0"
+mkdocs-gen-files = ">=0.5.0"
+mkdocs-awesome-pages-plugin = ">=2.9.2"
+mkdocstrings = {extras = ["python"], version = "^0.25.1"}
 
 [tool.poetry.scripts]
 -c = "poethepoet:main"
@@ -40,15 +39,10 @@ mkapi = "^1.0.14"
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.black]
-line-length = 79
-target-version = ['py310']
-include = '\.pyi?$'
-
 [tool.ruff]
-ignore = ["E501"]
+lint.ignore = ["E501"]
 line-length = 79
-select = [
+lint.select = [
     "C9",
     "E",
     "F",
@@ -66,21 +60,20 @@ select = [
 ]
 
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 10
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/*" = ["S101"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = """
 --verbose \
 --maxfail=1 \
---reverse \
 --color=yes \
 --cov={{cookiecutter.package_name}} \
 --html=docs/pytest_report.html \
@@ -119,9 +112,9 @@ test = "pytest"
 install-pre-commit = "pre-commit install"
 run-pre-commit = "pre-commit run --all-files"
 pre-commit = ["install-pre-commit", "run-pre-commit"]
-lint-ruff = "ruff check **/*.py --fix"
-lint-black = "black **/*.py"
-lint = ["lint-black", "lint-ruff"]
+ruff-check = "ruff check **/*.py --fix"
+ruff-format = "ruff format **/*.py"
+lint = ["ruff-check", "ruff-format"]
 doc = "mkdocs serve --use-directory-urls -f docs/mkdocs.yaml"
 doc-html = "mkdocs build --no-directory-urls -f docs/mkdocs.yaml"
 doc-publish = """mkdocs gh-deploy \

{{cookiecutter.project_slug}}/pyproject.toml

@@ -4,6 +4,7 @@
 as test files in pytest. The new features will trigger errors because
 steps are not implemented.
 """
+
 from pathlib import Path
 
 import pytest
@@ -31,7 +32,6 @@ def pytest_configure(config: pytest.Config) -> None:
         features = []
 
     for feat in features:
-
         feature_dir = Path(feat.filename).parent
         file_dir = (
             conftest_dir / "steps" / feature_dir.relative_to(features_base_dir)

{{cookiecutter.project_slug}}/tests/scenarios/conftest.py

@@ -11,14 +11,13 @@
   *  Prefer tmpdir over global test artifacts
 
 """
-from typing import TypeVar
+
+from typing import Self
 
 import pytest
 
 from {{cookiecutter.package_name}} import {{cookiecutter.module_name}} as m
 
-Self = TypeVar("Self", bound="TestGroup")
-
 
 @pytest.mark.parametrize(
     ("param1", "param2"),