# 
[](https://github.com/copier-org/copier)
[](https://gitpod.io/#https://github.com/copier-org/copier)
[](https://codecov.io/gh/copier-org/copier)
[](https://github.com/copier-org/copier/actions?query=branch%3Amaster)
[](http://mypy-lang.org/)
[](https://pypi.org/project/copier/)
[](https://github.com/psf/black)
[](https://copier.readthedocs.io/en/latest)
A library and CLI app for rendering project templates.
- Works with **local** paths and **Git 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.
## Installation
1. Install Python 3.9 or newer.
1. Install Git 2.27 or newer.
1. To use as a CLI app: `pipx install copier`
1. To use as a library: `pip install copier` or `conda install -c conda-forge copier`
### Nix flake
To install latest Copier release with 100% reproducibility:
```shell
nix profile install 'https://flakehub.com/f/copier-org/copier/*.tar.gz'
```
## Quick start
To create a template:
```shell
📁 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
```
```yaml title="copier.yml"
# questions
project_name:
type: str
help: What is your project name?
module_name:
type: str
help: What is your Python module name?
```
```python+jinja title="{{project_name}}/{{module_name}}.py.jinja"
print("Hello from {{module_name}}!")
```
```yaml+jinja title="{{_copier_conf.answers_file}}.jinja"
# Changes here will be overwritten by Copier
{{ _copier_answers|to_nice_yaml -}}
```
To generate a project from the template:
- On the command-line:
```shell
copier copy path/to/project/template path/to/destination
```
- Or in Python code, programmatically:
```python
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")
```
## Basic concepts
Copier is composed of these main concepts:
1. **Templates**. They lay out how to generate the subproject.
1. **Questionnaires**. They are configured in the template. Answers are used to generate
projects.
1. **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:
1. **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...
1. **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:
1. **[Code scaffolding](<https://en.wikipedia.org/wiki/Scaffold_(programming)>)**. Help
consumers have a working source code tree as quickly as possible. All templates allow
scaffolding.
1. **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 templates
You can browse public Copier templates on GitHub using
[the `copier-template` topic](https://github.com/topics/copier-template). Use them as
inspiration!
If you want your template to appear in that list, just add the topic to it! 🏷
## Show your support
If you're using Copier, consider adding the Copier badge to your project's `README.md`:
```md
[](https://github.com/copier-org/copier)
```
...or `README.rst`:
```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:
<!-- prettier-ignore-start -->
```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>
```
<!-- prettier-ignore-end -->
### Copier badge variations
1. Badge Grayscale Border
[](https://github.com/copier-org/copier)
1. Badge Grayscale Inverted Border
[](https://github.com/copier-org/copier)
1. Badge Grayscale Inverted Border Orange
[](https://github.com/copier-org/copier)
1. Badge Grayscale Inverted Border Red
[](https://github.com/copier-org/copier)
1. Badge Grayscale Inverted Border Teal
[](https://github.com/copier-org/copier)
1. Badge Grayscale Inverted Border Purple
[](https://github.com/copier-org/copier)
1. Badge Black
[](https://github.com/copier-org/copier)
## Credits
Special thanks go to [jpsca](https://github.com/jpsca) for originally creating `Copier`.
This project would not be a thing without him.
Many thanks to [pykong](https://github.com/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](https://github.com/yajo) for his relentless zest for
improving `Copier` even further.
Thanks a lot, [pawamoy](https://github.com/pawamoy) for polishing very important rough
edges and improving the documentation and UX a lot.
Also special thanks to [sisp](https://github.com/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! ⭐
<a href="https://star-history.com/#copier-org/copier&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=copier-org/copier&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=copier-org/copier&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=copier-org/copier&type=Date" />
</picture>
</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/copier-org/copier",
"name": "copier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Ben Felder",
"author_email": "ben@felder.io",
"download_url": "https://files.pythonhosted.org/packages/c4/84/b99005e18cb07986a9fa1c1314c9bb461851dc115ab24d3d9ac668daad7f/copier-9.4.1.tar.gz",
"platform": null,
"description": "# \n\n[](https://github.com/copier-org/copier)\n[](https://gitpod.io/#https://github.com/copier-org/copier)\n[](https://codecov.io/gh/copier-org/copier)\n[](https://github.com/copier-org/copier/actions?query=branch%3Amaster)\n[](http://mypy-lang.org/)\n\n[](https://pypi.org/project/copier/)\n[](https://github.com/psf/black)\n[](https://copier.readthedocs.io/en/latest)\n\nA library and CLI app for rendering project templates.\n\n- Works with **local** paths and **Git URLs**.\n- Your project can include any file and Copier can dynamically replace values in any\n kind of text file.\n- It generates a beautiful output and takes care of not overwriting existing files\n unless instructed to do so.\n\n\n\n## Installation\n\n1. Install Python 3.9 or newer.\n1. Install Git 2.27 or newer.\n1. To use as a CLI app: `pipx install copier`\n1. To use as a library: `pip install copier` or `conda install -c conda-forge copier`\n\n### Nix flake\n\nTo install latest Copier release with 100% reproducibility:\n\n```shell\nnix profile install 'https://flakehub.com/f/copier-org/copier/*.tar.gz'\n```\n\n## Quick start\n\nTo create a template:\n\n```shell\n\ud83d\udcc1 my_copier_template # your template project\n\u251c\u2500\u2500 \ud83d\udcc4 copier.yml # your template configuration\n\u251c\u2500\u2500 \ud83d\udcc1 .git/ # your template is a Git repository\n\u251c\u2500\u2500 \ud83d\udcc1 {{project_name}} # a folder with a templated name\n\u2502 \u2514\u2500\u2500 \ud83d\udcc4 {{module_name}}.py.jinja # a file with a templated name\n\u2514\u2500\u2500 \ud83d\udcc4 {{_copier_conf.answers_file}}.jinja # answers are recorded here\n```\n\n```yaml title=\"copier.yml\"\n# questions\nproject_name:\n type: str\n help: What is your project name?\n\nmodule_name:\n type: str\n help: What is your Python module name?\n```\n\n```python+jinja title=\"{{project_name}}/{{module_name}}.py.jinja\"\nprint(\"Hello from {{module_name}}!\")\n```\n\n```yaml+jinja title=\"{{_copier_conf.answers_file}}.jinja\"\n# Changes here will be overwritten by Copier\n{{ _copier_answers|to_nice_yaml -}}\n```\n\nTo generate a project from the template:\n\n- On the command-line:\n\n ```shell\n copier copy path/to/project/template path/to/destination\n ```\n\n- Or in Python code, programmatically:\n\n ```python\n from copier import run_copy\n\n # Create a project from a local path\n run_copy(\"path/to/project/template\", \"path/to/destination\")\n\n # Or from a Git URL.\n run_copy(\"https://github.com/copier-org/copier.git\", \"path/to/destination\")\n\n # You can also use \"gh:\" as a shortcut of \"https://github.com/\"\n run_copy(\"gh:copier-org/copier.git\", \"path/to/destination\")\n\n # Or \"gl:\" as a shortcut of \"https://gitlab.com/\"\n run_copy(\"gl:copier-org/copier.git\", \"path/to/destination\")\n ```\n\n## Basic concepts\n\nCopier is composed of these main concepts:\n\n1. **Templates**. They lay out how to generate the subproject.\n1. **Questionnaires**. They are configured in the template. Answers are used to generate\n projects.\n1. **Projects**. This is where your real program lives. But it is usually generated\n and/or updated from a template.\n\nCopier targets these main human audiences:\n\n1. **Template creators**. Programmers that repeat code too much and prefer a tool to do\n it for them.\n\n **_Tip:_** Copier doesn't replace the DRY principle... but sometimes you simply\n can't be DRY and you need a DRYing machine...\n\n1. **Template consumers**. Programmers that want to start a new project quickly, or\n that want to evolve it comfortably.\n\nNon-humans should be happy also by using Copier's CLI or API, as long as their\nexpectations are the same as for those humans... and as long as they have feelings.\n\nTemplates have these goals:\n\n1. **[Code scaffolding](<https://en.wikipedia.org/wiki/Scaffold_(programming)>)**. Help\n consumers have a working source code tree as quickly as possible. All templates allow\n scaffolding.\n1. **Code lifecycle management**. When the template evolves, let consumers update their\n projects. Not all templates allow updating.\n\nCopier tries to have a smooth learning curve that lets you create simple templates that\ncan evolve into complex ones as needed.\n\n## Browse or tag public templates\n\nYou can browse public Copier templates on GitHub using\n[the `copier-template` topic](https://github.com/topics/copier-template). Use them as\ninspiration!\n\nIf you want your template to appear in that list, just add the topic to it! \ud83c\udff7\n\n## Show your support\n\nIf you're using Copier, consider adding the Copier badge to your project's `README.md`:\n\n```md\n[](https://github.com/copier-org/copier)\n```\n\n...or `README.rst`:\n\n```rst\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json\n :target: https://github.com/copier-org/copier\n :alt: Copier\n```\n\n...or, as HTML:\n\n<!-- prettier-ignore-start -->\n```html\n<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>\n```\n<!-- prettier-ignore-end -->\n\n### Copier badge variations\n\n1. Badge Grayscale Border\n [](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border\n [](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Orange\n [](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Red\n [](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Teal\n [](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Purple\n [](https://github.com/copier-org/copier)\n\n1. Badge Black\n [](https://github.com/copier-org/copier)\n\n## Credits\n\nSpecial thanks go to [jpsca](https://github.com/jpsca) for originally creating `Copier`.\nThis project would not be a thing without him.\n\nMany thanks to [pykong](https://github.com/pykong) who took over maintainership on the\nproject, promoted it, and laid out the bases of what the project is today.\n\nBig thanks also go to [yajo](https://github.com/yajo) for his relentless zest for\nimproving `Copier` even further.\n\nThanks a lot, [pawamoy](https://github.com/pawamoy) for polishing very important rough\nedges and improving the documentation and UX a lot.\n\nAlso special thanks to [sisp](https://github.com/sisp) for being very helpful in\npolishing documentation, fixing bugs, helping the community and cleaning up the\ncodebase.\n\nAnd thanks to all financial supporters and folks that give us a shiny star! \u2b50\n\n<a href=\"https://star-history.com/#copier-org/copier&Date\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=copier-org/copier&type=Date&theme=dark\" />\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=copier-org/copier&type=Date\" />\n <img alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=copier-org/copier&type=Date\" />\n </picture>\n</a>\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for rendering project templates.",
"version": "9.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/copier-org/copier/issues",
"Homepage": "https://github.com/copier-org/copier",
"Repository": "https://github.com/copier-org/copier"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d965e8edaef8be1bd0a17943e6a011d4fc311f340e45733ef910a6f0b688587",
"md5": "4aeaeee354015fd11857bc0a1fe6327d",
"sha256": "863385b7ba8a9090c832cd12ca072dba9153397dbe7c5f337bf8c3d8859efa32"
},
"downloads": -1,
"filename": "copier-9.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4aeaeee354015fd11857bc0a1fe6327d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 43188,
"upload_time": "2024-10-18T18:36:40",
"upload_time_iso_8601": "2024-10-18T18:36:40.231054Z",
"url": "https://files.pythonhosted.org/packages/8d/96/5e8edaef8be1bd0a17943e6a011d4fc311f340e45733ef910a6f0b688587/copier-9.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c484b99005e18cb07986a9fa1c1314c9bb461851dc115ab24d3d9ac668daad7f",
"md5": "f0080db0f4e6703e58f0dc38716ba0af",
"sha256": "cc81d8204cb17fbc8c4a14996a8ce764166c34c77236de38cfbeb960c887b68f"
},
"downloads": -1,
"filename": "copier-9.4.1.tar.gz",
"has_sig": false,
"md5_digest": "f0080db0f4e6703e58f0dc38716ba0af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 41510,
"upload_time": "2024-10-18T18:36:42",
"upload_time_iso_8601": "2024-10-18T18:36:42.149058Z",
"url": "https://files.pythonhosted.org/packages/c4/84/b99005e18cb07986a9fa1c1314c9bb461851dc115ab24d3d9ac668daad7f/copier-9.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 18:36:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "copier-org",
"github_project": "copier",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "copier"
}
JSON
