Package: copier
A library and CLI app for rendering project templates.Works withlocalpaths andGit URLs.Your project can include any file and Copier can dynamically replace values in any
kind of text file.It generates a beautiful output and takes care of not overwriting existing files
unless instructed to do so.InstallationInstall Python 3.8 or newer.Install Git 2.27 or newer.To use as a CLI app:pipx install copierTo use as a library:pip install copierorconda install -c conda-forge copierNix flakeTo install latest Copier release with 100% reproducibility:nixprofileinstall'https://flakehub.com/f/copier-org/copier/*.tar.gz'Quick startTo 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# questionsproject_name:type:strhelp:What is your project name?module_name:type:strhelp: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:copiercopypath/to/project/templatepath/to/destinationOr in Python code, programmatically:fromcopierimportrun_copy# Create a project from a local pathrun_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")Basic conceptsCopier is composed of these main concepts:Templates. They lay out how to generate the subproject.Questionnaires. They are configured in the template. Answers are used to generate
projects.Projects. This is where your real program lives. But it is usually generated
and/or updated from a template.Copier targets these main human audiences:Template creators. Programmers that repeat code too much and prefer a tool to do
it for them.!!! tipCopier 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:Code scaffolding. Help
consumers have a working source code tree as quickly as possible. All templates allow
scaffolding.Code lifecycle management. When the template evolves, let consumers update their
projects. Not all templates allow updating.Copier tries to have a smooth learning curve that lets you create simple templates that
can evolve into complex ones as needed.Browse or tag public templatesYou can browse public Copier templates on GitHub usingthecopier-templatetopic. Use them as
inspiration!If you want your template to appear in that list, just add the topic to it! 🏷CreditsSpecial thanks go tojpscafor originally creatingCopier.
This project would not be a thing without him.Many thanks topykongwho took over maintainership on the
project, promoted it, and laid out the bases of what the project is today.Big thanks also go toyajofor his relentless zest for
improvingCopiereven further.Thanks a lot,pawamoyfor polishing very important rough
edges and improving the documentation and UX a lot.Also special thanks tosispfor 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! ⭐