Merge pull request #6 from max-pfeiffer/feature/github_workflow

Feature/GitHub workflow

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.pre-commit-config.yaml

@@ -7,7 +7,10 @@ repos:
       - id: detect-private-key
       - id: check-added-large-files
   - repo: https://github.com/psf/black
-    rev: 23.11.0
+    rev: 23.12.1
     hooks:
       - id: black
-        language_version: python3.9
+        language_version: python3.11
+        args:
+          - "--config"
+          - "./pyproject.toml"

README.md

@@ -1,6 +1,6 @@
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![codecov](https://codecov.io/gh/max-pfeiffer/uvicorn-poetry-project-template/branch/main/graph/badge.svg?token=WQI2SJJLZN)](https://codecov.io/gh/max-pfeiffer/uvicorn-poetry-project-template)
+[![codecov](https://codecov.io/gh/max-pfeiffer/uvicorn-poetry-fastapi-project-template/graph/badge.svg?token=OFQU8YVFAR)](https://codecov.io/gh/max-pfeiffer/uvicorn-poetry-fastapi-project-template)
 ![pipeline workflow](https://github.com/max-pfeiffer/uvicorn-poetry-project-template/actions/workflows/pipeline.yml/badge.svg)
 # uvicorn-poetry-project-template
 [Cookiecutter](https://github.com/cookiecutter/cookiecutter) project template for starting a containerized Fast API project.

cookiecutter.json

@@ -7,5 +7,6 @@
   "author_email": "",
   "python_version": ["3.12.0", "3.11.6", "3.10.13"],
   "operating_system_variant": ["slim-bookworm", "bookworm"],
+  "github_workflow": [true, false],
   "_extensions": ["cookiecutter.extensions.SlugifyExtension"]
 }

hooks/post_gen_project.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+from shutil import rmtree
+
+REMOVE_PATHS: list[str] = [
+    "{% if not cookiecutter.github_workflow %}.github{% endif %}",
+]
+
+for path in REMOVE_PATHS:
+    if path and Path(path.strip()).exists():
+        path_object: Path = Path(path.strip())
+        path_object.unlink() if path_object.is_file() else rmtree(path_object)

pyproject.toml

@@ -1,20 +1,20 @@
 [tool.poetry]
 name = "fast-api-micro-service-template"
-version = "1.1.0"
+version = "1.3.0"
 description = "A Cookiecutter template for spinning up a micro service"
 authors = ["Max Pfeiffer <[email protected]>"]
 
 [tool.poetry.dependencies]
 python = "3.11.*"
 
 [tool.poetry.dev-dependencies]
-black = "23.12.0"
+black = "23.12.1"
 cookiecutter = "2.5.0"
-coverage = "7.3.3"
+coverage = "7.4.0"
 docker = "7.0.0"
 furl = "2.1.3"
-httpx = "0.25.2"
-pytest = "7.4.3"
+httpx = "0.26.0"
+pytest = "7.4.4"
 pre-commit = "3.6.0"
 pytest-cookies = "0.7.0"
 pytest-cov = "4.1.0"

tests/test_custom_config.py

@@ -20,6 +20,7 @@ def test_custom_config(cookies) -> None:
             "author_email": "[email protected]",
             "python_version": "3.10.13",
             "operating_system_variant": "bookworm",
+            "github_workflow": False,
         }
     )
 
@@ -46,3 +47,9 @@ def test_custom_config(cookies) -> None:
 
     assert dfp.is_multistage
     assert all(["3.10.13-bookworm" in image for image in dfp.parent_images])
+
+    # Check for GitHub workflow
+    workflow: Path = (
+        result.project_path / ".github" / "workflows" / "pipeline.yml"
+    )
+    assert not workflow.exists()

tests/test_default_config.py

@@ -31,3 +31,9 @@ def test_default_config(cookies) -> None:
 
     assert dfp.is_multistage
     assert all(["3.12.0-slim-bookworm" in image for image in dfp.parent_images])
+
+    # Check for GitHub workflow
+    workflow: Path = (
+        result.project_path / ".github" / "workflows" / "pipeline.yml"
+    )
+    assert workflow.exists()

{{cookiecutter.project_slug}}/.github/workflows/pipeline.yml

@@ -0,0 +1,63 @@
+name: Pipeline
+
+on: push
+
+jobs:
+  code-quality:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: {{ cookiecutter.python_version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.7.1
+          virtualenvs-in-project: true
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-{{ "${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}" }}
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: |
+          poetry install --no-interaction --no-root
+      - name: Run pylint and black
+        run: |
+          source .venv/bin/activate
+          black --check .
+
+  run-tests:
+    needs: code-quality
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: {{ cookiecutter.python_version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.7.1
+          virtualenvs-in-project: true
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-{{ "${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}" }}
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: |
+          poetry install --no-interaction --no-root
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          pytest

{{cookiecutter.project_slug}}/app/main.py

@@ -1,11 +1,9 @@
-from typing import Dict
-
 from fastapi import FastAPI
 
 app = FastAPI()
 
 HELLO_WORLD: str = "Hello World!"
-ITEMS: Dict[str, str] = {"1": "sausage", "2": "ham", "3": "tofu"}
+ITEMS: dict[str, str] = {"1": "sausage", "2": "ham", "3": "tofu"}
 
 
 @app.get("/")

{{cookiecutter.project_slug}}/pyproject.toml

@@ -15,11 +15,11 @@ uvicorn = {version = "0.24.0.post1", extras = ["standard"]}
 fastapi = "0.104.1"
 
 [tool.poetry.dev-dependencies]
-black = "23.11.0"
-coverage = "7.3.3"
+black = "23.12.1"
+coverage = "7.4.0"
 httpx = "0.26.0"
 pre-commit = "3.6.0"
-pytest = "7.4.3"
+pytest = "7.4.4"
 pytest-cov = "4.1.0"
 requests = "2.28.1"