copier.yml

# CONFIGURATION -------------------------
_subdirectory: project
_templates_suffix: .jinja
_skip_if_exists:
  - CHANGELOG.md
  - CREDITS.md
_tasks:
  - python scripts/post_generation.py
_migrations:
  - version: 0.1.0
    before:
      - rm docs/changelog.md
      - rm docs/index.md
      - rm docs/contributing.md
      - rm docs/code_of_conduct.md
      - rm docs/credits.md

# PROMPT --------------------------------
project_name:
  type: str
  help: Your project name

project_description:
  type: str
  help: Your project description

author_fullname:
  type: str
  help: Your full name

author_email:
  type: str
  help: Your email

author_username:
  type: str
  help: Your username (e.g. on GitHub)

repository_provider:
  type: str
  help: Your repository provider
  default: github.com
  choices:
    - github.com
    - gitlab.com

repository_namespace:
  type: str
  help: Your repository namespace
  default: "[[ author_username ]]"

repository_name:
  type: str
  help: Your repository name
  default: "[[ project_name|lower|replace('_', '-')|replace(' ', '-') ]]"

copyright_holder:
  type: str
  help: The name of the person/entity holding the copyright
  default: "[[ author_fullname ]]"

copyright_holder_email:
  type: str
  help: The email of the person/entity holding the copyright
  default: "[[ author_email ]]"

copyright_date:
  type: str
  help: The copyright date
  default: "2021"

copyright_license:
  type: str
  help: Your project's license
  default: ISC License
  choices:
    - Academic Free License v3.0
    - Apache License 2.0
    - Artistic License 2.0
    - BSD 2-Clause "Simplified" License
    - BSD 3-Clause Clear License
    - BSD 3-Clause "New" or "Revised" License
    - Boost Software License 1.0
    - Creative Commons Attribution 4.0
    - Creative Commons Attribution Share Alike 4.0
    - Creative Commons Zero v1.0 Universal
    - Do What The F*ck You Want To Public License
    - Educational Community License v2.0
    - Eclipse Public License 1.0
    - Eclipse Public License 2.0
    - European Union Public License 1.1
    - European Union Public License 1.2
    - GNU Affero General Public License v3.0
    - GNU General Public License v2.0
    - GNU General Public License v3.0
    - GNU Lesser General Public License v2.1
    - GNU Lesser General Public License v3.0
    - ISC License
    - LaTeX Project Public License v1.3c
    - MIT License
    - Mozilla Public License 2.0
    - Microsoft Public License
    - Microsoft Reciprocal License
    - University of Illinois/NCSA Open Source License
    - SIL Open Font License 1.1
    - Open Software License 3.0
    - PostgreSQL License
    - The Unlicense
    - zlib License

python_package_distribution_name:
  type: str
  help: Your Python package distribution name (for `pip install NAME`)
  default: "[[ project_name|lower|replace('_', '-')|replace(' ', '-') ]]"

python_package_import_name:
  type: str
  help: Your Python package import name (for `import NAME` in Python code)
  default: "[[ project_name|lower|replace('-', '_')|replace(' ', '_') ]]"

python_package_command_line_name:
  type: str
  help: Your CLI name if any (for use in the shell)
  default: "[[ project_name|lower|replace('_', '-')|replace(' ', '-') ]]"

use_precommit:
  type: bool
  help: Do you want to use pre-commit?
  default: no