copier.yml

---
# questions
author_name:
  type: str
  help: "Full name of the Author"
  placeholder: "John Doe"

author_email:
  type: str
  help: "E-mail of the Author"
  placeholder: "jonhdoe@example.com"

github_username:
  type: str
  help: "GitHub Username"

project_name:
  type: str
  help: "Project Name (human readable version)"
  placeholder: "Python Package"

project_slug:
  type: str
  help: "Project slug (used for GitHub, PyPI, etc.)"
  default: "{{ project_name.lower().replace(' ', '-') }}"

package_name:
  type: str
  help: "The name of the main Python package (should be a valid Python identifier)"
  default: "{{ project_slug.replace('-', '_') }}"

project_short_description:
  type: str
  help: "A short description of the project"
  placeholder: "A super helpful small Python package."

software_license:
  type: str
  help: Your project's license?
  default: MIT License
  choices:
    - Apache License 2.0
    - Eclipse Public License 2.0
    - GNU General Public License v3.0
    - GNU Lesser General Public License v3.0
    - ISC License
    - MIT License
    - Mozilla Public License 2.0

# GitHub Sponsors - question
github_sponsors:
  type: bool
  help: "Use GitHub Sponsors?"
  default: true

# Ko-fi sponsor - question
kofi_funding:
  type: bool
  help: "Use Ko-fi?"
  default: true

# Ko-fi username - input
kofi_username:
  type: str
  help: "Ko-fi username"
  when: "{{ kofi_funding == true }}"

# Tweet on release - question
tweet_on_release:
  type: bool
  help: "Sending tweets on release?"
  default: true

# Twitter username - input
twitter_username:
  type: str
  help: "Twitter username (without @)"
  when: "{{ tweet_on_release == true }}"

# Poetry install - question
run_poetry_install:
  type: bool
  help: "Run poetry install after {{ package_name }} generation?"
  default: true

# Initial commit - question
initial_commit:
  type: bool
  help: "Create an initial commit with the generated {{ package_name }}?"
  when: "{{ run_poetry_install == true }}"
  default: false

# Pre-commit hooks - question
setup_pre_commit:
  type: bool
  help: "Setup pre-commit hooks (requires pre-commit)?"
  when: "{{ run_poetry_install == true }}"
  default: false

# =====================================
# | Copier settings for this template |
# =====================================
_min_copier_version: "9.1.0"

# The template root is found here
_subdirectory: template
_templates_suffix: .j2
_message_after_copy: Your package "{{ package_name }}" has been created successfully!
_tasks:
  # Remove Github Sponsor line from FUNDING.yml
  - "{% if not github_sponsors %}sed -i '' '/github:/d' .github/FUNDING.yml{% endif %}"
  # Remove Ko-fi line from FUNDING.yml
  - "{% if not kofi_funding %}sed -i '' '/ko_fi:/d' .github/FUNDING.yml{% endif %}"
  # Remove FUNDING.yml if neither GitHub Sponsor nor Ko-fi is chosen
  - "{% if not github_sponsors and not kofi_funding %}rm -f .github/FUNDING.yml{% endif %}"

  # Run poetry install
  - "{% if run_poetry_install %}poetry install{% endif %}"
  # Initial commit
  - "{% if initial_commit %}git init{% endif %}"
  - "{% if initial_commit %}git add .{% endif %}"
  - "{% if initial_commit %}git commit -m 'project - initial commit'{% endif %}"
  # Setup pre-commit
  - "{% if setup_pre_commit %}pre-commit install{% endif %}"