copier.yml

# Copyright 2023 Sophie Katz
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this
# software and associated documentation files (the “Software”), to deal in the Software
# without restriction, including without limitation the rights to use, copy, modify,
# merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be included in all copies
# or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# Configuration
#---------------------------------------------------------------------------------------

_subdirectory: template

_jinja_extensions:
  - jinja2_time.TimeExtension

_tasks:
  - [
    "{{ _copier_python }}",
    "{{ _copier_conf.src_path }}/scripts/post_copy.py",
    "--python-version",
    "{{ python_version }}",
    "--cuda-version",
    "{% if not cuda_version %}not_applicable{% else %}{{ cuda_version }}{% endif %}",
  ]

# Questions
#---------------------------------------------------------------------------------------

project_name:
  type: str
  help: Project name
  placeholder: " My Project"

project_description:
  type: str
  help: Project description
  placeholder: " A short description of the project"

module_name:
  type: str
  help: Python module name
  default: |-
    {{ project_name | lower | replace('-', '_') | replace(' ', '_') }}

package_name:
  type: str
  help: Python package name
  default: |-
    {{ module_name | replace('_', '-') }}

package_version:
  type: str
  help: Python package version
  default: 0.1.0

author_name:
  type: str
  help: Author name
  default: ""

author_email:
  type: str
  help: Author email
  default: ""

license:
  type: str
  help: License
  choices:
    None: none
    MIT: mit
    GNU LGPL v3.0: lgpl30
  default: none

copyright_holder:
  type: str
  help: Copyright holder
  default: |-
    {{ author_name }}
  when: |-
    {{ license != 'none' }}

python_version:
  type: str
  help: Python 3.x version
  choices:
    3.8: 3-8
    3.9: 3-9
    3.10: 3-10
    3.11: 3-11
  default: 3-11

use_pytorch:
  type: bool
  help: Use Pytorch?
  default: false

use_tensorflow:
  type: bool
  help: Use Tensorflow?
  default: false

cuda_version:
  type: str
  help: CUDA version on your machine (other users can specify theirs when using the project)
  choices:
    Default (CPU or MPS): default
    11.7: cuda-11-7
    11.8: cuda-11-8
  when: |-
    {{ use_pytorch }}

use_scikit_learn:
  type: bool
  help: Use Scikit?
  default: false

use_comet:
  type: bool
  help: Add comet.ai integration?
  default: false

use_vscode:
  type: bool
  help: Add VS Code support?
  default: true