A library and CLI app for rendering project templates.
pipx install copier
pip install copier
or conda install -c conda-forge copier
To install latest Copier release with 100% reproducibility:
nix profile install 'https://flakehub.com/f/copier-org/copier/*.tar.gz'
To create a template:
π my_copier_template # your template project
βββ π copier.yml # your template configuration
βββ π .git/ # your template is a Git repository
βββ π {{project_name}} # a folder with a templated name
β βββ π {{module_name}}.py.jinja # a file with a templated name
βββ π {{_copier_conf.answers_file}}.jinja # answers are recorded here
# questions
project_name:
type: str
help: What is your project name?
module_name:
type: str
help: What is your Python module name?
print("Hello from {{module_name}}!")
# Changes here will be overwritten by Copier
{{ _copier_answers|to_nice_yaml -}}
To generate a project from the template:
On the command-line:
copier copy path/to/project/template path/to/destination
Or in Python code, programmatically:
from copier import run_copy
# Create a project from a local path
run_copy("path/to/project/template", "path/to/destination")
# Or from a Git URL.
run_copy("https://github.com/copier-org/copier.git", "path/to/destination")
# You can also use "gh:" as a shortcut of "https://github.com/"
run_copy("gh:copier-org/copier.git", "path/to/destination")
# Or "gl:" as a shortcut of "https://gitlab.com/"
run_copy("gl:copier-org/copier.git", "path/to/destination")
Copier is composed of these main concepts:
Copier targets these main human audiences:
Template creators. Programmers that repeat code too much and prefer a tool to do it for them.
Tip: Copier doesn't replace the DRY principle... but sometimes you simply can't be DRY and you need a DRYing machine...
Template consumers. Programmers that want to start a new project quickly, or that want to evolve it comfortably.
Non-humans should be happy also by using Copier's CLI or API, as long as their expectations are the same as for those humans... and as long as they have feelings.
Templates have these goals:
Copier tries to have a smooth learning curve that lets you create simple templates that can evolve into complex ones as needed.
You can browse public Copier templates on GitHub using
the copier-template
topic. Use them as
inspiration!
If you want your template to appear in that list, just add the topic to it! π·
If you're using Copier, consider adding the Copier badge to your project's README.md
:
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
...or README.rst
:
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json
:target: https://github.com/copier-org/copier
:alt: Copier
...or, as HTML:
<a href="https://github.com/copier-org/copier"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json" alt="Copier" style="max-width:100%;"/></a>
Special thanks go to jpsca for originally creating Copier
.
This project would not be a thing without him.
Many thanks to pykong who took over maintainership on the project, promoted it, and laid out the bases of what the project is today.
Big thanks also go to yajo for his relentless zest for
improving Copier
even further.
Thanks a lot, pawamoy for polishing very important rough edges and improving the documentation and UX a lot.
Also special thanks to sisp for being very helpful in polishing documentation, fixing bugs, helping the community and cleaning up the codebase.
And thanks to all financial supporters and folks that give us a shiny star! β