copier.yml

---
# Copier Settings for the project
!include copier-settings.yml
---

author_full_name:
  type: str
  help: What is your full name?
  default: "John Doe"
  placeholder: "John Doe"
  validator: "{% from pathjoin('includes', 'validators.jinja') import validate_full_name %}{{ validate_full_name(author_full_name) }}"

author_email:
  type: str
  help: What is your email address?
  default: "johndoe@example.com"
  placeholder: "johndoe@example.com"
  validator: "{% from pathjoin('includes', 'validators.jinja') import validate_email %}{{ validate_email(author_email) }}"

github_username:
  type: str
  help: What is your GitHub username or organization name?
  placeholder: "username"
  default: "jjjermiah"
  validator: "{% from pathjoin('includes', 'validators.jinja') import validate_github_username %}{{ validate_github_username(github_username) }}"

project_name:
  type: str # Any value will be treated raw as a string
  help: What is your project name? (human readable allowed)
  default: "Just Another Python Package"
  placeholder: "My Project"
  validator: "{% from pathjoin('includes', 'validators.jinja') import validate_project_name %}{{ validate_project_name(project_name) }}"

project_slug:
  type: str
  help: Project slug for use in URLs, filenames, Github repo, etc.
  default: "{% from pathjoin('includes', 'slugify.jinja') import slugify%}{{ slugify(project_name) }}"
  validator: "{% from pathjoin('includes', 'validators.jinja') import validate_slug %}{{ validate_slug(project_slug) }}"

package_name:
  type: str
  help: What is your Python package name?
  default: "{{ project_slug.replace('-', '_') }}"
  validator: "{% from pathjoin('includes', 'validators.jinja') import validate_package_name %}{{ validate_package_name(package_name) }}"

package_description:
  type: str
  help: A short description of your package.
  default: "TODO:: Add a short description of {{ package_name }} here."

python_version:
  type: str
  help: What is the minimum Python version required?
  default: "3.10"
  choices:
    - "3.10"
    - "3.11"
    - "3.12"
    - "3.13"

software_license:
  type: str
  help: Choose a software license for your project.
  default: "MIT"
  default: MIT License
  choices:
    - Apache License 2.0
    - Eclipse Public License 2.0
    - GNU General Public License v3.0
    - GNU Lesser General Public License v3.0
    - ISC License
    - MIT License
    - Mozilla Public License 2.0

# TODO: Run a git init command in tasks
git_init:
  type: bool
  help: Initialize a git repository?
  default: true

# TODO let user choose which build backend
build_backend:
  type: str
  help: Choose a build backend for your project.
  default: "hatch"
  choices:
    - hatch
    # - poetry
    # - flit
    # - setuptools
    # - distutils

pixi_install:
  type: bool
  help: Run `pixi install` after copying files?
  default: true

pixi_install_envs:
  type: str
  help: List of environments to install.
  multiselect: true
  choices:
    - default
    - dev
    - docs
    - quality
    - publish
  default : ["dev"]
  when: "{{ pixi_install == true }}"