copier.yml

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

# PROMPT --------------------------------
project_name:
  type: str
  help: Please provide the name of your project.
  validator: >-
    {% if not project_name %} You must provide a name for the project. {% endif
    %}

org:
  type: str
  help: What GitHub user is this project under?
  validator: >-
    {% if not org %} You must provide a org for the project. It might just be
    your user name on the site (like GitHub) you are targeting. {% endif %}

url:
  type: str
  help: Provide/modify the url to your GitHub repository if needed.
  default: "https://github.com/{{org}}/{{project_name}}"

python_name:
  type: str
  help: The Python package import name (for `import NAME` in Python code)
  default: "{{ project_name|lower|replace('-', '_')|replace(' ', '_') }}"

full_name:
  type: str
  help: Who's the main responsible for this code?
  placeholder: My Name
  validator: >-
    {% if not full_name %} You must provide a name (possibly yours) to place in
    your config files. {% endif %}

email:
  type: str
  help: What's their 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 to place in
    your config files.
    {% endif %}

project_short_description:
  type: str
  help: Write a short description of your project.
  default: A great package.

license:
  type: str
  help: Select a license
  choices:
    - BSD
    - Apache
    - MIT
    - GPL

min_python_version:
  type: str
  help: What is the minimum version of Python your project will support? (Defaults to minimum supported by NumPy)
  default: "3.10"
  validator: >-
    {% if not (min_python_version | regex_search('[3][.][0-9]+')) %}
    Please supply a valid Python 3 version (e.g. 3.11).
    {% endif %}

typing:
  type: str
  help: Would you like to use static type checking? (This configures mypy.)
  choices:
    "No/I'll configure it myself.": no_typing
    "Basic type checking (type annotations not required).": loose
    "Full type checking (type annotations required).": strict

coc:
  type: str
  help: We provide a basic Code of Conduct that can be modified to suit the needs of your project. Would you like to use this, or write your own?
  choices:
    "I'll use/modify the basic Code of Conduct.": our_coc
    "I'll write my own Code of Conduct.": their_coc