Merge pull request #7 from ilbumi/add_changelog_generation

Add changelog generation and Dev Containers Support

Author: ilbumi

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace

copier.yml

@@ -120,4 +120,9 @@ python_package_import_name:
 python_package_command_line_name:
   type: str
   help: Your CLI name if any (for use in the shell)
-  default: "{{ project_name | slugify }}"
+  default: "{{ project_name | slugify }}"
+
+docker_base_image:
+  type: str
+  help: Base image for the dev container. Edit Dockerfile.dev if your image is not ubuntu-based or have no python installed.
+  default: "python:3.11"

project/.devcontainer/Dockerfile.dev.jinja

@@ -0,0 +1,12 @@
+ARG BASE_IMAGE={{ docker_base_image }}
+FROM ${BASE_IMAGE}
+RUN apt-get update \
+        && apt-get install build-essential git gcc -y \
+        && apt-get clean
+
+RUN pip install -U pip setuptools wheel
+RUN pip install pdm
+
+RUN mkdir /data
+
+CMD ""

project/.devcontainer/devcontainer.json.jinja

@@ -0,0 +1,23 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
+{
+    "name": "Development docker containers",
+    "dockerComposeFile": "docker-compose.yml",
+    "service": "app",
+    "workspaceFolder": "/app",
+    "shutdownAction": "stopCompose",
+    "overrideCommand": true,
+    "customizations": {
+            "vscode": {
+                    "extensions": [
+                        "vivaxy.vscode-conventional-commits",
+                        "DavidAnson.vscode-markdownlint",
+                        "ionutvmi.path-autocomplete",
+                        "ms-python.vscode-pylance",
+                        "ms-python.python",
+                        "ms-python.black-formatter",
+                        "charliermarsh.ruff"
+                ]
+            }
+    }
+}

project/.devcontainer/docker-compose.yml

@@ -0,0 +1,11 @@
+version: "3.8"
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile.dev
+    command: "/bin/sh -c \"while sleep 1000; do :; done\""
+    user: "${UID}:${GID}"
+    volumes:
+      - "../:/app"

project/noxfile.py.jinja

@@ -71,3 +71,13 @@ def check_safety(session: Session) -> None:
             "pdm", "export", "-f", "requirements", "-o", requirements.name, "--without-hashes", external=True
         )
         session.run("safety", "check", f"--file={requirements.name}", "--full-report")
+
+
+@nox.session
+def generate_changelog(session: Session) -> None:
+    """Generate changelog from the commits. It should be reviewed and cleaned up by a human.
+
+    Args:
+        session (Session): nox session object
+    """
+    session.run("git-changelog", "-Tbio", "CHANGELOG.md", "-c", "angular")

project/setup_project.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+git init .
+git add -A .
+git commit -m "feat: init a repo"
+
+pdm install

tests/setup.sh

@@ -34,6 +34,4 @@ copier copy --trust --defaults -r HEAD "${template}" "${DEST}" \
 -d repository_provider="github.com"
 
 pushd $DEST
-git init .
-git add -A .
-git commit -m "feat: init a repo"
+source setup_project.sh