copier.yml

# questions
organization:
  type: str
  help: |
    GitHub organization or username for this repository.
    E.g., "microsoft", "your_username", "your_organization", etc.
  default: microsoft

project_name:
  type: str
  help: What is your project name?
  validator: >-
    {% if not (project_name | regex_search('^[a-zA-Z_][a-zA-Z0-9\-_]*$')) %}
    project_name must start with a letter, followed by one or more letters, digits, dashes or underscores.
    {% endif %}

module_name:
  type: str
  help: What is your Python module name? Can be the same as your project's name.
  default: "{{ project_name|lower|replace(' ', '_')|replace('-', '_') }}"
  validator: >-
    {% if not (module_name | regex_search('^[a-zA-Z_][a-zA-Z0-9_]*')) %}
    project_name must start with a letter, followed by one or more letters, digits or underscores.
    {% endif %}

documentation:
  type: bool
  help: |
    Do you want to include documentation in your project?
    This will add a `docs` directory with mkdocs setup and CI builds.
  default: false

precommit:
  type: bool
  help: |
    Do you want to include pre-commit hooks in your project?
    This will add a `.pre-commit-config.yaml` file with some basic hooks.
  default: false

commitizen:
  type: bool
  help: |
    Do you want to include commitizen in your project?
    This will add a `.cz.toml` file and `commitizen` hooks to .pre-commit-config.yaml (if used).
  default: false

microsoft_internal:
  type: bool
  help: If the project belongs to a Microsoft internal organization
  when: "{{ false }}"
  default: "{{ organization in ['microsoft', 'technology-and-research', 'health-futures', 'ai4science'] }}"

license:
  type: str
  when: "{{not microsoft_internal}}"
  help: |
    What is the copyright holder for the generated LICENSE? Your Name, Your Organization, etc.
  default: "{% if not microsoft_internal %}{{organization}}{% else %}Microsoft Corporation{% endif %}"

repo_exists:
  type: bool
  help: |
    Does this repository already exist on GitHub? This question will give you instructions
    create your repository on GitHub later on.
  default: false

_subdirectory: template

_exclude:
  - CHANGELOG.md
  - cookie-doh.code-workspace
  - pdm.lock
  - copier.yaml
  - copier.yml
  - .git
  - .DS_Store
  - .svn
  - "~*"
  - "*.py[co]"
  - __pycache__

_message_after_copy: |
  Your project "{{ project_name }}" has been created successfully! 🎉

  Required dependencies:
  * Make sure you have `python >= 3.10` and `pdm` installed.
  * Instructions: https://microsoft.github.io/cookie-doh/dev_setup
  * You can also install optional tools like `direnv` and `pre-commit` following the link above
  if needed for your project.

  Next steps:

  1. Change directory and initialize GitHub:

     $ cd {{ _copier_conf.dst_path }}  # direnv will ask you to type `direnv allow` (if you have direnv installed)
     $ git init

  {% if repo_exists -%}
  2. Pull repository into your newly created project:

     $ git remote add origin https://github.com/{{ organization }}/{{ project_name }}.git
     $ git pull origin main  # and resolve any conflicts

  {% else -%}
  2. Create a new repository on GitHub:

    a. Install the GitHub CLI (if you haven't already): https://cli.github.com/
    b. Authenticate with GitHub and create the new repository:

       $ gh auth login
       $ gh repo create {{ organization }}/{{ project_name }} --private --source=. --remote=origin
       $ cd {{ _copier_conf.dst_path }}

  {% endif -%}

  3. Add project dependencies to `pyproject.toml` and install them with PDM:

     $ pdm add <new-dependencies>  # optional
     $ pdm install

  4. Add the project outputs, configure pre-commit and commit your changes:

     $ git add .
     {% if precommit -%}
     $ pre-commit install --install-hooks
     {% endif -%}
     $ git commit -m "init: initialize repo"

  5. Happy coding! 🚀

_message_after_update: |
  Your project "{{ project_name }}" has been updated! 🎉
  In case there are any conflicts, please resolve them. Then, you're done! 🚀

_message_before_copy: |
  💃 Thanks for generating a project using our template! 🕺