Add Docker template bits

Author: smkent

cookiecutter.json

@@ -12,6 +12,7 @@
     ],
     "enable_coverage": "yes",
     "enable_pypi_publish": "no",
+    "enable_container_publish": "no",
     "author_name": "",
     "author_email": "",
     "github_user": ""

hooks/post_gen_project.py

@@ -1,15 +1,36 @@
+import itertools
 import os
 import shutil
 import subprocess
 from typing import Dict, List
 
+import yaml
+
 TEMPLATE_ONLY_DATA = "cookiecutter_template_data"
 
 
 def _run(call: List[str], env: Dict[str, str]) -> None:
     subprocess.run(call, env=env).check_returncode()
 
 
+# Remove files and directories for deselected features
+with open(
+    os.path.join(os.getcwd(), TEMPLATE_ONLY_DATA, "feature_paths.yml")
+) as f:
+    feature_paths = yaml.safe_load(f.read())
+for rm_path in itertools.chain.from_iterable(
+    [
+        feature_data["paths"]
+        for _, feature_data in feature_paths.items()
+        if not feature_data["enabled"]
+    ]
+):
+    full_rm_path = os.path.join(os.getcwd(), rm_path)
+    shutil.rmtree(full_rm_path) if os.path.isdir(full_rm_path) else os.remove(
+        full_rm_path
+    )
+
+
 # Remove template-only data files
 shutil.rmtree(os.path.join(os.getcwd(), TEMPLATE_ONLY_DATA))
 

tests/test_new_cookie.py

@@ -47,7 +47,11 @@ def test_new_cookie_create(temp_dir: str) -> None:
         .decode("utf-8")
         .strip()
     ), "Untracked files present in template-rendered project"
-    subprocess.check_call(["poetry", "install"], cwd=project_dir)
+
     subprocess.check_call(
         ["poetry", "run", "cruft", "diff", "--exit-code"], cwd=project_dir
     )
+    # Install rendered project
+    subprocess.check_call(["poetry", "install"], cwd=project_dir)
+    # Run rendered project's tests
+    subprocess.check_call(["poetry", "run", "poe", "test"], cwd=project_dir)

tests/test_template.py

@@ -95,8 +95,16 @@ def test_project_license(cookies: Any, project_license: str) -> None:
 @pytest.mark.parametrize(
     "enable_pypi_publish", [True, False], ids=["pypi", "no pypi"]
 )
+@pytest.mark.parametrize(
+    "enable_container_publish",
+    [True, False],
+    ids=["container", "no container"],
+)
 def test_rendered_project(
-    cookies: Any, enable_coverage: bool, enable_pypi_publish: bool
+    cookies: Any,
+    enable_coverage: bool,
+    enable_pypi_publish: bool,
+    enable_container_publish: bool,
 ) -> None:
     extra_context = dict(
         author_name="Ness",
@@ -134,14 +142,6 @@ def test_rendered_project(
         .strip()
     ), "Untracked files present in template-rendered project"
 
-    # Install rendered project
-    subprocess.check_call(["poetry", "install"], cwd=result.project_path)
-
-    # Run rendered project's tests
-    subprocess.check_call(
-        ["poetry", "run", "poe", "test"], cwd=result.project_path
-    )
-
 
 @pytest.mark.parametrize(**ReadmeCases.all_cases().__dict__)
 def test_rendered_readme(

{{cookiecutter.project_name}}/.dockerignore

@@ -0,0 +1 @@
+.gitignore

{{cookiecutter.project_name}}/.github/workflows/container.yml

@@ -0,0 +1,65 @@
+---
+name: Build
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ "{{" }} github.repository }}
+  RELEASE_PYTHON_VERSION: "3.10"
+  RELEASE_POETRY_VERSION: "1.2"
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '*'
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+jobs:
+  Container:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: 💾 Check out repository
+        uses: actions/checkout@v3
+
+      - name: 🔑 Log in to the container registry
+        uses: docker/login-action@v2.1.0
+        with:
+          registry: ${{ "{{" }} env.REGISTRY }}
+          username: ${{ "{{" }} github.actor }}
+          password: ${{ "{{" }} secrets.GITHUB_TOKEN }}
+
+      - name: 📡 Collect image metadata
+        id: meta
+        uses: docker/metadata-action@v4.1.1
+        with:
+          images: ${{ "{{" }} env.REGISTRY }}/${{ "{{" }} env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{ "{{" }}version}}
+            type=semver,pattern={{ "{{" }}major}}.{{ "{{" }}minor}}
+            type=semver,pattern={{ "{{" }}major}},enable=${{ "{{" }} !startsWith(github.ref, 'refs/tags/v0.') }}
+            type=edge,branch=main
+
+      - name: 🐍 Set up Python project with Poetry
+        uses: ./.github/workflows/actions/python-poetry
+        with:
+          python_version: ${{ "{{" }} env.RELEASE_PYTHON_VERSION }}
+          poetry_version: ${{ "{{" }} env.RELEASE_POETRY_VERSION }}
+
+      - name: 🔥 Test
+        run: poetry run poe test
+
+      - name: 📦 Build and publish container image
+        uses: docker/build-push-action@v3.2.0
+        with:
+          context: .
+          push: ${{ "{{" }} github.event_name != 'pull_request' }}
+          tags: ${{ "{{" }} steps.meta.outputs.tags }}
+          labels: ${{ "{{" }} steps.meta.outputs.labels }}

{{cookiecutter.project_name}}/Dockerfile

@@ -0,0 +1,9 @@
+FROM python:3-alpine
+RUN apk add --no-cache tini
+COPY docker/entrypoint /
+
+COPY . /python-build
+RUN python3 -m pip install /python-build && rm -rf /python-build
+
+ENTRYPOINT ["/sbin/tini", "--"]
+CMD ["/entrypoint"]

{{cookiecutter.project_name}}/README.md

@@ -7,6 +7,39 @@
 [![GitHub stars](https://img.shields.io/github/stars/{{ cookiecutter.github_user }}/{{ cookiecutter.project_name }}?style=social)][repo]
 {% endif %}{% if cookiecutter.enable_pypi_publish == "yes" and not cookiecutter.github_user %}
 {% endif %}
+{% if cookiecutter.enable_container_publish == "yes" %}## Installation and usage with Docker
+
+Example `docker-compose.yaml`:
+
+```yaml
+version: "3.7"
+
+services:
+  {{ cookiecutter.project_name }}:
+    image: ghcr.io/{{ cookiecutter.github_user }}{{ cookiecutter.project_name }}:latest
+    restart: unless-stopped
+```
+
+Start the container by running:
+
+```console
+docker-compose up -d
+```
+
+Debugging information can be viewed in the container log:
+
+```console
+docker-compose logs -f
+```{% endif %}
+{% if cookiecutter.enable_pypi_publish == "yes" %}
+## Installation from PyPI
+
+[{{ cookiecutter.project_name }} is available on PyPI][pypi]:
+
+```console
+pip install {{ cookiecutter.project_name }}
+```
+{% endif %}
 ## Development
 
 ### [Poetry][poetry] installation

{{cookiecutter.project_name}}/cookiecutter_template_data/feature_paths.yml

@@ -0,0 +1,8 @@
+container_publish:
+  enabled: {{ cookiecutter.enable_container_publish|lower == 'yes' }}
+  paths:
+    - ".dockerignore"
+    - ".github/workflows/container.yml"
+    - "Dockerfile"
+    - "docker"
+    - "docker-compose.yaml"

{{cookiecutter.project_name}}/docker-compose.yaml

@@ -0,0 +1,6 @@
+version: "3.7"
+
+services:
+  {{ cookiecutter.project_name }}:
+    image: ghcr.io/{{ cookiecutter.github_user }}/{{ cookiecutter.project_name }}:latest
+    restart: unless-stopped

{{cookiecutter.project_name}}/docker/entrypoint

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+exec "{{ cookiecutter.project_name }}"