feat: parametrized docker setup + migrated to uv

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: "CI - linters and tests"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-and-test:
+    name: linters and tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.11
+
+      - name: install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install uv
+          uv sync --dev --no-cache-dir
+
+      - name: install just
+        run: |
+          sudo apt install just
+
+      - name: run tests
+        run: |
+          just test
+
+      - name: run linters in test catalog
+        run: |
+          just ci_lint_full

.gitignore

@@ -19,3 +19,4 @@ htmlcov
 .pytest_cache/
 /.vscode/
 .mypy_cache
+test_folder/

README.md

@@ -21,7 +21,7 @@ Familiarize yourself with the [copier templating engine](https://copier.readthed
 > If file not ends on `.jinja`, it will be copy-pasted as is.
 > When you add `.jinja` - make sure that there will no conflicts between template languages, or just wrap everything not related to copier templating in `{%raw%}` `{%endraw%}`
 
-### Prerequisities
+### Prerequisites
 
 1. Install python 3.11 or greater. Consider using [pyenv](https://github.com/pyenv/pyenv#installation) if you work with multiple python versions
 2. Install [uv](https://github.com/astral-sh/uv#installation)
@@ -31,6 +31,6 @@ Familiarize yourself with the [copier templating engine](https://copier.readthed
 
 1. run `uv run pytest` in your root directory
 
-### Running template localy
+### Running template locally
 
 1. copier cli: `copier copy . test-folder-path`

copier.yaml

@@ -7,12 +7,21 @@ _answers_file: .copier-answers.copier-python-project.yml
 # For a complete list of prompt options, see https://copier.readthedocs.io/en/stable/configuring/#advanced-prompt-formatting
 project_name:
   type: str
-  help: Provide the project name
+  help: Provide the project name (snake case, e.g. my_project)
 
 description:
   type: str
   help: Provide a short description of the project
 
-authors:
+author_name:
   type: str
-  help: Provide a list of authors in format "Firstname Lastname <email>, Firstname Lastname <email>, ..."
+  help: Provide an author name in format "Firstname Lastname"
+
+author_email:
+  type: str
+  help: Provide the author's email address
+
+docker:
+  type: bool
+  default: true
+  help: Enable Docker support

justfile

@@ -0,0 +1,37 @@
+PROJECT_NAME := "copier-python-project"
+TEST_ANSWERS_FILE := ".copier/.copier-answers." + PROJECT_NAME + ".yml"
+
+copy output="test_folder":
+    uv run copier copy . {{ output }} \
+    --vcs-ref=HEAD
+
+recopy output="test_folder":
+    uv run copier recopy {{ output }} \
+    --vcs-ref=HEAD \
+    --answers-file {{ TEST_ANSWERS_FILE }} \
+    --skip-answered \
+    --overwrite
+
+update output="test_folder":
+    uv run copier recopy {{ output }} \
+    --vcs-ref=HEAD \
+    --answers-file {{ TEST_ANSWERS_FILE }} \
+    --overwrite
+
+all_ff output="test_folder":
+    just recopy {{ output }}
+    just --justfile {{ output }}/justfile all_ff
+
+test:
+	uv run pytest
+
+ci_lint_full:
+	uv run copier copy . tmp/test_catalog \
+	--vcs-ref=HEAD \
+	--data project_name="test_project" \
+	--data description="..." \
+	--data author_name="Test Author" \
+	--data author_email="test@test.com" \
+	--data docker=false
+
+	just --justfile tmp/test_catalog/justfile lint_full_ff

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "copier-python-project"
 version = "0.1.0"
-description = "Template for empty dockerized python project."
+description = "Template for python project."
 authors = [{ name = "Piotr Karaś", email = "pepe500p@gmail.com" }]
 requires-python = ">=3.11"
 dependencies = []

skeleton/.github/workflows/ci.yml.jinja

@@ -0,0 +1,44 @@
+name: "CI - linters and tests"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-and-test:
+    name: linters and tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v3
+    {%- if docker %}
+
+      - name: run linters and tests
+        run: just dc _ci
+    {%- else %}
+
+      - name: setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.13
+
+      - name: install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install uv
+          uv sync --dev --no-cache-dir
+
+      - name: install just
+        run: |
+          sudo apt install just
+
+      - name: run linters
+        run: |
+          just _ci_lint
+
+      - name: run tests
+        run: |
+          just _ci_test
+    {%- endif %}

skeleton/.github/workflows/conventional-commit-pr-name.yml

@@ -1,11 +1,10 @@
 name: "Check PR title matches conventional commit specification"
 
 on:
+  push:
+    branches:
+      - main
   pull_request:
-    types:
-      - opened
-      - edited
-      - synchronize
 
 jobs:
   main:

skeleton/README.md.jinja

@@ -2,6 +2,7 @@
 
 {{ description }}
 
+{%- if docker %}
 1. Build docker image:
     ```
     docker compose build {{ project_name }}
@@ -11,12 +12,13 @@
     ```
     docker compose {{ project_name }} run bash
     ```
-    or with make
+    or with just
     ```
-    make dc_bash
+    just dc bash
     ```
 
 3. Run tests:
     ```
-    make test
+    just test
     ```
+{%- endif %}