copier.yml

---
!include constants.yml
---

_subdirectory: reproML
_answers_file: .reproML.yml

# basics
project_name:
  type: str
  help: What is your project name?
  default: "{{ _folder_name }}"
  validator: "{% if project_name|length < 1 %}Can not be empty.{% endif %}"

project_name_slug:
  type: str
  help: A slug of the name
  default: "{% from 'slugify.jinja' import slugify %}{{ slugify(project_name) }}"
  validator: "{% if project_name_slug|length < 1 %}Can not be empty.{% endif %}{% from 'slugify.jinja' import slugify %}{% if project_name_slug != slugify(project_name_slug) %}Invalid slug.{% endif %}"

project_description:
  type: str
  help: A brief summary of what you want to achieve.

python_version:
  type: str
  help: Which Python version do you want to use?
  choices:
    - "3.10"
    - "3.11"
    - "3.12"
    - "3.13"
    - "3.14"

author:
  type: str
  help: What is your name?

author_email:
  type: str
  help: What is your email adress?

# git integration
git_config:
  type: bool
  help: "Do you want to use these details for the initial commit?"
  default: true
  choices:
    "Yes, use '{{author}}' and '{{author_email}}'.": true
    No, use global git defaults.: false

ci:
  type: str
  help: What CI service do you want to use?
  choices:
    Skip for now: ""
    GitHub Actions: github
    GitLab CICD: gitlab

repo_url:
  type: str
  help: Where is the git repo hosted? Keep empty to skip.
  default: ""

default_branch:
  type: str
  help: What do you want to name your default branch?
  default: main
  validator: "{% from 'slugify.jinja' import slugify %}{% if default_branch != slugify(default_branch) %}Invalid branch name.{% endif %}"

# dvc
use_dvc:
  type: bool
  help: Dou you want to use data version control?
  default: false

remote_type:
  type: str
  help: Which storage backend do you want to install? If in doubt, start without one.
  choices:
    Install no backend: ""
    Amazon S3: s3
    Microsoft Azure Blob Storage: azure
    Google Cloud Storage: gs
    Google Drive: gdrive
    SSH and SFTP: ssh
    HDFS: hdfs
    WebDAV: webdav
    Aliyun OSS: oss
    Install all backends: all
  default: ""
  when: "{{ use_dvc }}"

remote_location:
  type: str
  help: Supply remote storage location. Keep empty to skip.
  placeholder: "{{ remote_type }}://"
  default: ""
  when: "{% if remote_type != '' %}{% if remote_type != 'all' %}{{ use_dvc }}{% endif %}{% endif %}"

# extra documentation
ethics_checklist:
  type: bool
  help: Do you want to add the deon ethics checklist to your documentation?
  default: true

# commands to run post generation
_tasks:
  # setup repo
  - command: "git init"
    when: "{{ _copier_operation != 'update' }}"

  - command: "git config user.name {{author}}"
    when: "{{ git_config and _copier_operation != 'update' }}"

  - command: "git config user.email {{author_email}}"
    when: "{{ git_config and _copier_operation != 'update' }}"

  - command: "git remote add origin {{repo_url}}"
    when: "{{ repo_url != '' and _copier_operation != 'update' }}"
  - command: "git remote set-url origin {{repo_url}}"
    when: "{{ repo_url != '' and _copier_operation == 'update' }}"

  # setup environment
  - "uv sync --python {{python_version}} --all-groups --all-extras"

  - command: "uv run pre-commit install --hook-type pre-push --hook-type post-checkout --hook-type pre-commit"
    when: "{{ _copier_operation != 'update' }}"

  # setup dvc
  - command: "uv run dvc remote add -d remote0 {{remote_location}}"
    when: "{{ remote_location != '' and _copier_operation != 'update' }}"
  - command: "uv run dvc remote modify remote0 url {{remote_location}}"
    when: "{{ remote_location != '' and _copier_operation == 'update' }}"

  # extra documentation
  - command: "uv run --with deon deon -o docs/ethics.md"
    when: "{{ ethics_checklist and _copier_operation != 'update' }}"

  # initial commit
  - command: "git checkout -b {{default_branch}}"
    when: "{{ _copier_operation != 'update' }}"

  - command: "git add ."
    when: "{{ _copier_operation != 'update' }}"

  - command: "git commit -m 'Init from template: github.com/Excidion/reproML'"
    when: "{{ _copier_operation != 'update' }}"


_exclude:
  - docs/reproML.md # only for docs of template itself