copier.yaml

_min_copier_version: '9'
_preserve_symlinks: true
_skip_if_exists:
  - CHANGELOG.md
_subdirectory: template

_message_after_copy: |
  {{ _copier_conf.dst_path }} is ready! Next steps:

  1. Create GitHub repository:
       https://github.com/new?owner={{ github_user }}&name={{ project_name }}

  2. Initialize git and environment:
       uv run poe init

  3. Push:
  {%- if project_visibility == 'private' %}
       git remote add origin <repo-url>
  {%- endif %}
       git push -u origin main
  {%- if project_visibility == 'public' %}

  For GitHub repository configuration and additional features setup,
  see copier-python's Completing Setup documentation at
  https://smkent.github.io/copier-python/project-setup/
  {%- if enable_docs %}
  OR run the documentation site locally:

       uv run poe docs

  Then, see One Time Setup at: http://localhost:8000/{{ project_name }}/setup/
  {%- endif %}
  {%- endif %}

_message_after_update: |
  Template update applied. Before committing:

    git diff         # review all changes
    uv run poe lint  # verify code quality
    uv run poe test  # verify tests pass

project_name:
  type: str
  qmark: 📝
  help: Project (repository) name
  default: '{{ _folder_name }}'
  validator: |
    {%- if not project_name -%}
      Required
    {%- elif project_name | lower | regex_replace('^([a-z0-9]|[a-z0-9][a-z0-9._-]*[a-z0-9])$','') != '' -%}
      Python package distribution name must only contain letters, numbers, or . - _
    {%- endif -%}

project_slug:
  type: str
  qmark: 🐍
  default: "{{ project_name | title | lower | regex_replace('[^a-za-z0-9]','_') | regex_replace('_{2,}', '_') | trim('_') }}"
  help: Python module import name (slug)
  validator: |
    {%- if not project_slug -%}
      Required
    {%- elif project_slug | lower | regex_replace('^[a-z_][a-z0-9_]*$','') != '' -%}
      Python package import name must only contain letters, numbers, or underscores
    {%- endif -%}

project_description:
  type: str
  qmark: 💬
  help: One-line project summary
  validator: '{% if not project_description %}Required{% endif %}'

project_type:
  type: str
  qmark: 🏗️
  help: Project type
  default: library
  choices:
    - application
    - library

project_visibility:
  type: str
  qmark: 🔒
  help: Project visibility
  default: public
  choices:
    - public
    - private

python_version_minimum:
  type: str
  qmark: 🐍
  help: Minimum Python version
  default: '3.10'
  choices:
    - '3.10'
    - '3.11'
    - '3.12'
    - '3.13'
    - '3.14'

python_version_maximum:
  type: str
  qmark: 🐍
  help: Maximum Python version
  default: No maximum
  choices: |
    - 'No maximum'
    {%- set min_minor = python_version_minimum.split(".")[1] | int -%}
    {%- for minor in range(min_minor, 15) %}
    - '3.{{ minor }}'
    {%- endfor %}

enable_coverage:
  type: bool
  qmark: 📊
  help: Enable coverage.io reports?
  default: "{{ project_visibility == 'public' }}"
  when: "{{ project_visibility == 'public' }}"

enable_pypi:
  type: bool
  qmark: 🚀
  help: Enable package publishing to PyPI?
  default: "{{ project_visibility == 'public' }}"
  when: "{{ project_visibility == 'public' }}"

enable_container:
  type: bool
  qmark: 📦
  help: Enable Docker container{% if project_visibility == 'public' %} build and publishing to ghcr.io{% endif %}?
  default: "{{ project_type == 'application' }}"

enable_docs:
  type: bool
  qmark: 📕
  help: Enable documentation site (Zensical{% if project_visibility == 'public' %} with deployment to GitHub Pages{% endif %})?
  default: yes

user_name:
  type: str
  qmark: 🧑
  help: Author's full name
  validator: '{% if not user_name %}Required{% endif %}'

user_email:
  type: str
  qmark: ✉️
  help: Author's email address
  validator: '{% if not user_email %}Required{% endif %}'

github_user:
  type: str
  qmark: 👾
  help: GitHub user or organization name
  when: "{{ project_visibility == 'public' }}"
  validator: '{% if not github_user %}Required{% endif %}'

copyright_holder:
  type: str
  qmark: ©️
  help: Copyright holder's full name
  default: '{{ user_name }}'

copyright_holder_email:
  type: str
  qmark: ✉️
  help: Copyright holder's email address
  default: '{{ user_email }}'

copyright_year:
  type: str
  qmark: 📅
  help: The copyright year (e.g. 2026)
  validator: |
    {%- if not copyright_year -%}
      Required
    {%- elif copyright_year | regex_replace('^[0-9]{4}$','') != '' -%}
      Invalid year
    {%- endif -%}

copyright_license:
  type: str
  qmark: ⚖️
  help: Project license
  default: "{% if project_type == 'library' %}L{% endif %}GPL-3.0"
  choices:
    Apache License 2.0: Apache-2.0
    BSD 3-Clause "New" or "Revised" License: BSD-3-Clause
    Creative Commons Attribution 4.0 International: CC-BY-4.0
    Creative Commons Attribution Share Alike 4.0 International: CC-BY-SA-4.0
    Creative Commons Zero v1.0 Universal: CC0-1.0
    GNU Affero General Public License v3.0: AGPL-3.0
    GNU General Public License v3.0 only: GPL-3.0
    GNU Lesser General Public License v3.0 only: LGPL-3.0
    ISC License: ISC
    MIT License: MIT

template_attribution:
  type: bool
  qmark: 🪧
  help: Add copier-python attribution to README.md?
  default: no