copier.yaml

# Copier template for Python projects
# Usage: uvx copier copy --trust gh:namitdeb739/python-template <project-dir>
# Docs:  https://namitdeb739.github.io/python-template

# --- Project identity ---

project_name:
  type: str
  help: Project name in kebab-case (e.g. my-ml-project)
  placeholder: my-project

package_name:
  type: str
  help: Python package name in snake_case (leave blank to auto-derive)
  default: "{{ project_name | replace('-', '_') }}"
  placeholder: my_project

description:
  type: str
  help: Short one-line description
  placeholder: A Python project

author_name:
  type: str
  help: Author full name
  placeholder: Your Name

author_email:
  type: str
  help: Author email
  placeholder: you@example.com

github_user:
  type: str
  help: GitHub username or organisation
  placeholder: your-username

# --- Feature toggles ---

# CI / security
ci_github:
  type: bool
  default: true
  help: Enable GitHub Actions CI/CD?

security:
  type: str
  default: basic
  help: "Security level"
  choices:
    "No security tooling": none
    "Pre-commit hooks + ruff linting": basic
    "Basic + CodeQL, pip-audit, Dependabot, branch protection": full

# Code quality
testing:
  type: str
  default: standard
  help: "Testing level"
  choices:
    "pytest only": minimal
    "pytest + coverage + fixtures": standard
    "Standard + coverage threshold + parametrized examples": full

use_typecheck:
  type: bool
  default: true
  help: Enable mypy strict type checking?

# Documentation & deployment
use_docs:
  type: bool
  default: true
  help: Include MkDocs documentation?

use_docker:
  type: str
  default: cpu
  help: "Docker support"
  choices:
    "No Docker": none
    "CPU Dockerfile + Compose": cpu
    "CPU + GPU Dockerfile": gpu

# Dev environment
use_devcontainer:
  type: bool
  default: false
  help: Include VS Code dev container config?

# Domain-specific extras
use_ml:
  type: bool
  default: false
  help: Include ML/data science setup (notebooks, data dir, optional deps)?

use_iot:
  type: bool
  default: false
  help: Include IoT/embedded setup (serial, GPIO, MQTT drivers, device config)?

use_cli:
  type: bool
  default: false
  help: Include Typer CLI scaffold (commands, --help, rich output)?

use_api:
  type: bool
  default: false
  help: Include FastAPI REST API scaffold (routes, health endpoint, uvicorn serve)?

use_db:
  type: bool
  default: false
  help: Include SQLAlchemy 2 + Alembic (database session, migrations)?

# --- Post-setup options ---

init_dvc:
  type: bool
  help: Initialise DVC for data versioning?
  default: false
  when: "{{ use_ml }}"

init_env:
  type: bool
  help: Create .env from .env.example?
  default: false
  when: "{{ use_ml }}"

_min_copier_version: "9.0.0"
_subdirectory: template

_exclude:
  - .git/
  - .venv/
  - site/
  - uv.lock

_tasks:
  # Rename source package directory to match package_name
  - command: mv src/project_name "src/{{ package_name }}"
    when: "{{ package_name != 'project_name' }}"
  # Remove disabled features
  - command: rm -rf .devcontainer/
    when: "{{ not use_devcontainer }}"
  - command: rm -rf "src/{{ package_name }}/drivers/" "src/{{ package_name }}/sensors/" config/
    when: "{{ not use_iot }}"
  - command: rm -f tests/test_drivers.py
    when: "{{ not use_iot }}"
  - command: rm -f "src/{{ package_name }}/cli.py"
    when: "{{ not use_cli }}"
  - command: rm -rf "src/{{ package_name }}/api/"
    when: "{{ not use_api }}"
  - command: rm -rf "src/{{ package_name }}/db/" alembic/ alembic.ini
    when: "{{ not use_db }}"
  - command: rm -rf docker/ .dockerignore
    when: "{{ use_docker == 'none' }}"
  - command: rm -f docker/Dockerfile.gpu
    when: "{{ use_docker != 'gpu' and use_docker != 'none' }}"
  - command: rm -rf docs/ mkdocs.yml
    when: "{{ not use_docs }}"
  - command: rm -rf notebooks/ data/ .env.example
    when: "{{ not use_ml }}"
  - command: rm -rf .github/workflows/ .github/dependabot.yml
    when: "{{ not ci_github }}"
  - command: rm -f .github/workflows/codeql.yml .github/workflows/dependabot-auto-merge.yml .github/dependabot.yml
    when: "{{ ci_github and security != 'full' }}"
  - command: rm -f .github/workflows/docs.yml
    when: "{{ ci_github and not use_docs }}"
  - command: rm -f .pre-commit-config.yaml
    when: "{{ security == 'none' }}"
  - command: rm -f tests/conftest.py tests/test_config.py
    when: "{{ testing == 'minimal' }}"
  # Initialise git and make initial commit
  - git init
  - git config core.longpaths true
  - git add -A
  - 'git commit -m "chore: initial project from template"'
  # Install dependencies and hooks
  - uv sync --dev
  - command: uv run pre-commit install
    when: "{{ security != 'none' }}"
  # Optional extras
  - command: uv run dvc init && uv run dvc config core.autostage true
    when: "{{ init_dvc }}"
  - command: cp .env.example .env
    when: "{{ init_env }}"

_message_after_copy: |

  Project {{ project_name }} is ready!

  Next steps:
    cd {{ project_name }}
    just check          # verify lint + type-check + tests all pass
  {% if ci_github %}
    just init-remote    # create GitHub repo, push, configure branch protection + Pages
  {% else %}
    git init && git add -A && git commit -m "chore: initial commit"
  {% endif %}

  Update later:
    uvx copier update --trust