Merge pull request #4 from max-pfeiffer/feature/configurable_python_v…

…ersion

Made python version and OS variant configurable

.github/workflows/pipeline.yml

@@ -3,7 +3,37 @@ 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: 3.11
+      - 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

cookiecutter.json

@@ -5,5 +5,7 @@
   "project_description": "",
   "author_name": "",
   "author_email": "",
+  "python_version": ["3.12.0", "3.10.13", "3.10.13"],
+  "operating_system_variant": ["slim-bookworm", "bookworm"],
   "_extensions": ["cookiecutter.extensions.SlugifyExtension"]
 }

pyproject.toml

@@ -19,6 +19,7 @@ pre-commit = "3.6.0"
 pytest-cookies = "0.7.0"
 pytest-cov = "4.1.0"
 toml = "0.10.2"
+dockerfile-parse = "2.0.1"
 
 # https://docs.pytest.org/en/latest/reference/customize.html
 [tool.pytest.ini_options]

tests/test_custom_config.py

@@ -2,6 +2,7 @@
 
 import toml
 from pytest_cookies.plugin import Result
+from dockerfile_parse import DockerfileParser
 
 
 def test_custom_config(cookies) -> None:
@@ -17,6 +18,8 @@ def test_custom_config(cookies) -> None:
             "project_description": "A project description which does make a lot of sense.",
             "author_name": "Jane Doe",
             "author_email": "jane.doe@unknown.com",
+            "python_version": "3.10.13",
+            "operating_system_variant": "bookworm",
         }
     )
 
@@ -35,3 +38,8 @@ def test_custom_config(cookies) -> None:
     assert toml_data["tool"]["poetry"]["authors"] == [
         "Jane Doe <jane.doe@unknown.com>"
     ]
+
+    dockerfile: Path = result.project_path / "Dockerfile"
+    dfp = DockerfileParser(path=str(dockerfile))
+
+    assert "3.10.13-bookworm" in dfp.baseimage

tests/test_default_config.py

@@ -2,6 +2,7 @@
 
 import toml
 from pytest_cookies.plugin import Result
+from dockerfile_parse import DockerfileParser
 
 
 def test_default_config(cookies) -> None:
@@ -22,3 +23,8 @@ def test_default_config(cookies) -> None:
     assert toml_data["tool"]["poetry"]["version"] == "0.0.0"
     assert toml_data["tool"]["poetry"]["description"] == ""
     assert toml_data["tool"]["poetry"]["authors"] == []
+
+    dockerfile: Path = result.project_path / "Dockerfile"
+    dfp = DockerfileParser(path=str(dockerfile))
+
+    assert "3.12.0-slim-bookworm" in dfp.baseimage

{{cookiecutter.project_slug}}/Dockerfile

@@ -1,6 +1,6 @@
 # Be aware that you need to specify these arguments before the first FROM
 # see: https://docs.docker.com/engine/reference/builder/#understand-how-arg-and-from-interact
-FROM pfeiffermax/uvicorn-poetry:3.2.0-python3.11.6-slim-bookworm
+FROM pfeiffermax/uvicorn-poetry:3.2.0-python{{ cookiecutter.python_version }}-{{ cookiecutter.operating_system_variant }}
 
 # install [tool.poetry.dependencies]
 # this will install virtual environment into /.venv because of POETRY_VIRTUALENVS_IN_PROJECT=true