Migrate template from Cookiecutter to Copier

Author: Debakel

README.md

@@ -1,6 +1,6 @@
-# 🍪 Python Cookie Cutter
+# 🍪 Copier Python Template
 
-[Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package.
+A [Copier](https://copier.readthedocs.io/en/stable/)  template for a Python package.
 
 ## Features
 - Testing with [pytest](https://docs.pytest.org/en/latest/)
@@ -11,31 +11,20 @@
 - Continuous Integration with [GitHub Actions](https://github.com/features/actions)
 - Architecture decisions documented in an [Architecture Decision Record](https://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)
 
-## Quickstart
 
-Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
+## Getting started 🚀
+### Prerequisites
+To use this template, first [install `copier`](https://github.com/copier-org/copier?tab=readme-ov-file#installation):
+```
+pip install pipx
+pipx install copier
+```
 
-    pip install -U cookiecutter
+### Usage
+Once `copier` is installed, generate a new python project with:
 
-Generate a Python package project:
 
-    cookiecutter gh:Debakel/python-cookiecutter
-
-Or, with `pipx` installed:
-
-    pipx run cookiecutter gh:Debakel/python-cookiecutter
-
-**Then:**
-
-    # Enter project directory
-    cd <repo_name>
-    
-    # Initialise git repo
-    git init
-    
-    # Install dependencies
-    pipenv install --dev
-    
-    # Setup pre-commit and pre-push hooks
-    pipenv run pre-commit install
+```
+copier copy https://github.com/Debakel/python-template.git --trust
+```
 

cookiecutter.json

@@ -0,0 +1,34 @@
+template_version:
+  default: 0.1.0
+  when: false
+
+_subdirectory: template
+
+_tasks:
+  - git init
+  - git add .
+  - git commit -m "Initial commit"
+
+
+project_name:
+  type: str
+  help: "Project name"
+  default: "Lorem Ipsum"
+
+project_description:
+  type: str
+  help: "Project description"
+
+package_name:
+  type: str
+  help: "Package name"
+  default: "{{ project_name.lower().replace(' ', '_').replace('-', '_') }}"
+  validator: >-
+    {% if not (package_name | regex_search('^[a-z][a-z0-9\_]+$')) %}
+    project_name must start with a letter, followed one or more letters, digits or dashes all lowercase.
+    {% endif %}
+
+python_version:
+  type: str
+  help: "Python version"
+  default: "3.12"

copier.yml

@@ -1,6 +1,6 @@
 [run]
-source = {{cookiecutter.repo_name}}
-omit = {{cookiecutter.repo_name}}/__main__.py
+source = {{package_name}}
+omit = {{package_name}}/__main__.py
 
 [report]
 exclude_lines =

hooks/post_gen_project.py

@@ -2,6 +2,6 @@
 **
 
 # ... except for dependencies and source
-!Pipfile
+!Pipfile.jinja
 !Pipfile.lock
-!{{cookiecutter.repo_name}}
+!{{package_name}}

hooks/pre_gen_project.py

@@ -13,7 +13,7 @@ jobs:
             -   name: Setup Python
                 uses: actions/setup-python@v1
                 with:
-                    python-version: '{{cookiecutter.python_version}}'
+                    python-version: '{{python_version}}'
 
             -   name: Install dependencies with pipenv
                 run: |

{{cookiecutter.repo_name}}/.coveragerc template/.coveragerc.jinja{{cookiecutter.repo_name}}/.coveragerc renamed to template/.coveragerc.jinja

@@ -14,7 +14,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v1
         with:
-          python-version: '{{cookiecutter.python_version}} '
+          python-version: '{{python_version}} '
 
       - name: Install dependencies with pipenv
         run: |
@@ -29,8 +29,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Build docker image
-        run: docker build . -t {{cookiecutter.repo_name}}:test
+        run: docker build . -t {{package_name}}:test
 
       - name: Smoke test docker image
         run: |
-          docker run --rm {{cookiecutter.repo_name}}:test 10
+          docker run --rm {{package_name}}:test 10