copier.yml

# CONFIGURATION -------------------------
_min_copier_version: "9"
_envops:
  autoescape: false
  keep_trailing_newline: true
_subdirectory: project
_templates_suffix: .jinja
_jinja_extensions:
- copier_templates_extensions.TemplateExtensionLoader
- extensions.py:CurrentYearExtension
- extensions.py:GitExtension
- extensions.py:SlugifyExtension
- extensions.py:GitHubIDsforGiscusExtension
_skip_if_exists:
- CHANGELOG.md
- docs/insiders/changelog.md

# PROMPT --------------------------------
language:
  type: str
  help: The language this handler operates for (e.g. "Ada" or "Brainfuck")

project_name:
  type: str
  help: Your project name
  default: "mkdocstrings-{{ language|lower }}"

project_description:
  type: str
  help: Your project description
  default: "A {{ language|title }} handler for mkdocstrings."

author_fullname:
  type: str
  help: Your full name
  default: "{{ 'Timothée Mazzucotelli' | git_user_name }}"

author_email:
  type: str
  help: Your email
  default: "{{ 'dev@pawamoy.fr' | git_user_email }}"

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

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

repository_namespace:
  type: str
  help: Your repository namespace
  default: "{{ author_username }}"

repository_name:
  type: str
  help: Your repository name
  default: "{{ project_name | slugify }}"

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: "{{ current_year }}"

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 | slugify }}"

python_package_import_name:
  type: str
  help: Your handler import name (for `import mkdocstrings_handlers.NAME` in Python code)
  default: "{{ language | slugify('_') }}"

insiders:
  type: bool
  help: Does this project have an Insiders version?
  default: false

insiders_repository_name:
  type: str
  help: Your Insiders repository name
  default: "{{ repository_name }}"
  when: "{{ insiders }}"

insiders_email:
  type: str
  help: The email to use for Insiders-related questions
  default: "{{ author_email }}"
  when: "{{ insiders }}"

public_release:
  type: bool
  help: Is this project already released publicly?
  default: false
  when: "{{ insiders }}"