A library and CLI app for rendering project templates.
Copiercan dynamically replace values in any kind of text file.
pipx install copier
pip install copier
Use it in your Python code:
from copier import run_auto # Create a project from a local path run_auto("path/to/project/template", "path/to/destination") # Or from a git URL. run_auto("https://github.com/copier-org/copier.git", "path/to/destination") # You can also use "gh:" as a shortcut of "https://github.com/" run_auto("gh:copier-org/copier.git", "path/to/destination") # Or "gl:" as a shortcut of "https://gitlab.com/" run_auto("gl:copier-org/copier.git", "path/to/destination")
Or as a command-line tool:
copier path/to/project/template 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.
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 in GitHub using
copier-template topic. Use them as
If you want your template to appear in that list, just add the topic to it! 🏷
Special thanks go to jpscaletti 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
Copier even further.
Thanks a lot, pawamoy for polishing very important rough edges and improving the documentation and UX a lot.