copiertv 1.0a0

Validates Copier templates instantiated with various presets.

📋 A generic validator for Copier templates. Instantiates templates with various preset answer files (variants) and runs configurable validation commands against the generated projects.

Key Features

• Configurable validation commands: Define validation commands in a TOML configuration file. The tool is agnostic about what gets validated.

• Configurable answers directory: Specify where variant answer files live. No hardcoded convention imposed.

• Placeholder interpolation: Use {template_directory}, {project_directory}, {temporary_directory}, and {variant} in command args and working directories.

• Copier Python API: Uses copier.run_copy directly instead of shelling out to a subprocess.

• Configuration hierarchy: CLI arguments, per-project config, and per-user config (via emcd-appcore) with clear precedence.

• Structured error handling: Domain-specific exceptions with Markdown rendering for terminal display.

Installation 📦

Method: Install Executable Script

Install via the uv tool command:

uv tool install copiertv

or, run directly with uvx:

uvx copiertv

Or, install via pipx:

pipx install copiertv

Method: Install Python Package

Install via uv pip command:

uv pip install copiertv

Or, install via pip:

pip install copiertv

Usage

Survey Variants

List available template variants (reads answers directory from configuration):

copiertv survey

Validate a Variant

Validate a template variant:

copiertv validate default

Preserve the generated project for inspection:

copiertv validate --preserve default

Configuration File

Create .auxiliary/configuration/copiertv/general.toml in your template repository:

[answers]
directory = "data/copier"

[[commands]]
args = ["hatch", "env", "prune"]

[[commands]]
args = ["hatch", "--env", "develop", "run", "make-all"]

[options]
preserve = false
unsafe = false

Commands support placeholder interpolation for paths:

[[commands]]
args = ["make", "check", "--source", "{project_directory}"]
cwd = "{template_directory}"

Available placeholders: {template_directory}, {project_directory}, {temporary_directory}, {variant}.

Contribution 🤝

Contribution to this project is welcome! However, it must follow the code of conduct for the project.

Please file bug reports and feature requests in the issue tracker or submit pull requests to improve the source code or documentation.

For development guidance and standards, please see the development guide.

Additional Indicia

Other Projects by This Author 🌟

• python-absence (absence on PyPI)

  🕳️ A Python library package which provides a sentinel for absent values - a falsey, immutable singleton that represents the absence of a value in contexts where None or False may be valid values.

• python-accretive (accretive on PyPI)

  🌌 A Python library package which provides accretive data structures - collections which can grow but never shrink.

• python-classcore (classcore on PyPI)

  🏭 A Python library package which provides foundational class factories and decorators for providing classes with attributes immutability and concealment and other custom behaviors.

• python-detextive (detextive on PyPI)

  🕵️ A Python library which provides consolidated text detection capabilities for reliable content analysis. Offers MIME type detection, character set detection, and line separator processing.

• python-dynadoc (dynadoc on PyPI)

  📝 A Python library package which bridges the gap between rich annotations and automatic documentation generation with configurable renderers and support for reusable fragments.

• python-falsifier (falsifier on PyPI)

  🎭 A very simple Python library package which provides a base class for falsey objects - objects that evaluate to False in boolean contexts.

• python-frigid (frigid on PyPI)

  🔒 A Python library package which provides immutable data structures - collections which cannot be modified after creation.

• python-icecream-truck (icecream-truck on PyPI)

  🍦 Flavorful Debugging - A Python library which enhances the powerful and well-known icecream package with flavored traces, configuration hierarchies, customized outputs, ready-made recipes, and more.

• python-librovore (librovore on PyPI)

  🐲 Documentation Search Engine - An intelligent documentation search and extraction tool that provides both a command-line interface for humans and an MCP (Model Context Protocol) server for AI agents. Search across Sphinx and MkDocs sites with fuzzy matching, extract clean markdown content, and integrate seamlessly with AI development workflows.

• python-mimeogram (mimeogram on PyPI)

  📨 A command-line tool for exchanging collections of files with Large Language Models - bundle multiple files into a single clipboard-ready document while preserving directory structure and metadata… good for code reviews, project sharing, and LLM interactions.