copier.yml

# CONFIGURATION -------------------------
_subdirectory: project_template
_templates_suffix: ""
_skip_if_exists:
  - CHANGELOG.md

_tasks:
  - "git init"
  - "uv sync"
  - "uv run pre-commit install"

# PROMPT --------------------------------
project_name:
  type: str
  help: The name of your project (used for the directory, package name, and repo).
  validator: >-
    {% if not project_name %} You must provide a name for the project. {% endif %}

project_short_description:
  type: str
  help: A short description of your project.
  default: A Python project

python_name:
  type: str
  help: The Python package import name (for `import NAME` in Python code).
  default: "{{ project_name|lower|replace('-', '_')|replace(' ', '_') }}"
  validator: >-
    {% if not (python_name | regex_search('^[a-zA-Z_][a-zA-Z0-9_]*$')) %}
    Must be a valid Python identifier (letters, digits, underscores; cannot start with a digit).
    {% endif %}

full_name:
  type: str
  help: Author name.
  placeholder: My Name
  validator: >-
    {% if not full_name %} You must provide an author name. {% endif %}

email:
  type: str
  help: Author email.
  placeholder: me@email.com
  validator: >-
    {% if not (email | regex_search('^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$')) %}
    You must provide a valid email address.
    {% endif %}

license:
  type: str
  help: Select a license.
  choices:
    MIT: MIT
    BSD-3-Clause: BSD
    Apache-2.0: Apache
    GPL-3.0-or-later: GPL

min_python_version:
  type: str
  help: Minimum Python version to support.
  default: "3.11"
  choices:
    "3.11": "3.11"
    "3.12": "3.12"
    "3.13": "3.13"

include_docs:
  type: bool
  help: Include MkDocs Material documentation scaffolding?
  default: true

org:
  type: str
  help: GitHub organisation or username.
  default: alan-turing-institute
  validator: >-
    {% if not org %} You must provide a GitHub org or username. {% endif %}

url:
  type: str
  help: Repository URL.
  default: "https://github.com/{{org}}/{{project_name}}"