feat: Add Copier template for project generation (#5)

This commit introduces a Copier template to streamline project setup, which in turn can generate the main branch

The template includes:

 - copier.yml: Defines project configuration options such as project_name, module_name, description, user_name, user_email, python_version, and include_dockerfile.
 - Renamed and templated pyproject.toml to pyproject.toml.jinja to dynamically set project metadata, based on user input.
 - Renamed module directory postmodern to {{ module_name }} and its contents (__init__.py, __main__.py, adder.py, cli.py, hello.py, server.py) to allow for customizable module names.
 - Renamed test_import.py to test_import.py.jinja for templating.

The python_version field now includes validation to ensure it follows the X.Y.Z format.

Co-authored-by: Jakob Stender Guldberg <jakob1379gmail.com>

Author: jakob1379

.github/workflows/render-template.yml

@@ -0,0 +1,64 @@
+name: Render Copier Template
+
+on:
+  push:
+    branches:
+      - template
+
+jobs:
+  render:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          path: main
+
+      - name: Checkout template branch
+        uses: actions/checkout@v4
+        with:
+          ref: template
+          path: template
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install uv
+        run: pip install uv
+        working-directory: ${{ github.workspace }}/template
+
+        # comment
+      - name: Render template
+        run: |
+          cd ${{ github.workspace }}/template
+          uvx copier copy \
+            --overwrite \
+            --defaults \
+            -d description="Add your description here" \
+            -d include_dockerfile=true \
+            -d module_name=postmodern \
+            -d project_name=postmodern-python \
+            -d python_version=3.13 \
+            -d user_email=you@example.com \
+            -d user_name="Your Name" \
+            . ../main/
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Commit and Push Changes
+        run: |
+          cd ${{ github.workspace }}/main
+          rm -f .copier-answers.yml
+          git add .
+          if ! git diff --cached --exit-code; then
+            git commit -m "Auto-render main template: ${{ github.event.head_commit.message }}"
+            git push origin main
+          else
+            echo "No changes to commit."
+          fi

copier.yml

@@ -0,0 +1,60 @@
+---
+
+project_name:
+  type: str
+  help: Give your project an amazing name
+  
+module_name:
+  type: str
+  help: Give the module a name
+  default: "{{ project_name }}"
+
+description:
+  type: str
+  help: Make a short description for the project (optional).
+  default: ""
+  
+user_name:
+  type: str
+  help: Set your full name
+  
+user_email:
+  type: str
+  help: Set your email
+  
+python_version:
+  type: str
+  help: What python version do you want to use? (optional)
+  default: 3.13
+  validators:
+    - >-
+      {{
+        (
+          value.isdigit() # X format
+          or (
+            value.replace('.', '').isdigit() and
+            value.count('.') == 1 and
+            (value.split('.') | length) == 2 and
+            value.split('.')[0].isdigit() and
+            value.split('.')[1].isdigit()
+          ) # X.Y format
+          or (
+            value.replace('.', '').isdigit() and
+            value.count('.') == 2 and
+            (value.split('.') | length) == 3 and
+            value.split('.')[0].isdigit() and
+            value.split('.')[1].isdigit() and
+            value.split('.')[2].isdigit()
+          ) # X.Y.Z format
+        )
+        or 'Version must be in X, X.Y, or X.Y.Z format (e.g., 3, 3.13, or 3.13.4) with numbers only, no <, >, =, or other characters.'
+      }}
+include_dockerfile:
+  type: bool
+  help: "Include a Dockerfile in the project?"
+  default: yes
+
+_src_path: project_template
+_exlude:
+  - .venv/
+  - .git/

postmodern/__main__.py

@@ -11,17 +11,17 @@ all = [ {ref="fmt"}, {ref="lint"}, {ref="check"}, {ref="test"} ]
 "ci:lint" = "ruff check"
 
 [project]
-name = "postmodern"
+name = "{{module_name}}"
 version = "0.1.0"
-description = "Add your description here"
+description = "{{description}}"
 readme = "README.md"
 authors = [
-    { name = "Your Name", email = "you@example.com" }
+    { name = "{{ user_name | title }}", email = "{{ user_email }}" }
 ]
 
 # Public libraries should be more lenient
 # Internal stuff should enforce ~=3.13!
-requires-python = ">=3.11"
+requires-python = ">={{python_version}}"
 dependencies = [
     "pydantic>=2.10.4",
 ]
@@ -69,7 +69,7 @@ select = [
 
 [tool.ruff.lint.isort]
 # so it knows to group first-party stuff last
-known-first-party = ["postmodern"]
+known-first-party = ["{{ module_name }}"]
 
 [tool.pyright]
 venvPath = "."          # uv installs the venv in the current dir

postmodern/hello.py

@@ -0,0 +1,5 @@
+from {{module_name}}.hello import main
+
+
+def test_hello():
+    main()

pyproject.toml pyproject.toml.jinjapyproject.toml renamed to pyproject.toml.jinja

@@ -1,5 +1,5 @@
 # --- Base Stage: Install Dependencies ---
-FROM python:3.13.1-slim-bookworm AS base
+FROM python:{{python_version}}-slim-bookworm AS base
 
 ENV PYTHONUNBUFFERED=True
 WORKDIR /app
@@ -14,7 +14,7 @@ COPY pyproject.toml uv.lock ./
 RUN uv sync --frozen
 
 # --- Final Stage: Build Application Image ---
-FROM python:3.13.1-slim-bookworm AS runner
+FROM python:{{python_version}}-slim-bookworm AS runner
 
 WORKDIR /app
 
@@ -25,4 +25,4 @@ COPY --from=base /app/.venv ./.venv
 COPY . /app
 
 # Set the entrypoint
-CMD ["/app/.venv/bin/python", "/app/postmodern/server.py"]
+CMD ["/app/.venv/bin/python", "/app/{{module_name}}/server.py"]