{"id":13468361,"url":"https://github.com/copier-org/copier","last_synced_at":"2026-04-10T16:05:41.392Z","repository":{"id":37042526,"uuid":"2690104","full_name":"copier-org/copier","owner":"copier-org","description":"Library and command-line utility for rendering projects templates.","archived":false,"fork":false,"pushed_at":"2025-05-08T10:23:38.000Z","size":4539,"stargazers_count":2487,"open_issues_count":103,"forks_count":206,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-08T17:17:36.190Z","etag":null,"topics":["cookiecutter","copier-template","hacktoberfest","project-template","python","scaffolding"],"latest_commit_sha":null,"homepage":"https://copier.readthedocs.io/en/stable/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/copier-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["Yajo"]}},"created_at":"2011-11-01T19:22:44.000Z","updated_at":"2025-05-08T15:31:59.000Z","dependencies_parsed_at":"2023-11-16T15:27:39.650Z","dependency_job_id":"13b41968-df72-48f5-92cb-1ee8ce9ed412","html_url":"https://github.com/copier-org/copier","commit_stats":{"total_commits":1012,"total_committers":60,"mean_commits":"16.866666666666667","dds":0.7895256916996047,"last_synced_commit":"2d5b6610ca097651bf3d2e38c70bd923aa9412ef"},"previous_names":["jpscaletti/voodoo","lucuma/voodoo"],"tags_count":73,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copier-org%2Fcopier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copier-org%2Fcopier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copier-org%2Fcopier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copier-org%2Fcopier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/copier-org","download_url":"https://codeload.github.com/copier-org/copier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514567,"owners_count":21920334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","copier-template","hacktoberfest","project-template","python","scaffolding"],"created_at":"2024-07-31T15:01:09.478Z","updated_at":"2026-04-10T16:05:41.377Z","avatar_url":"https://github.com/copier-org.png","language":"Python","readme":"# ![Copier](https://github.com/copier-org/copier/raw/master/img/copier-logotype.png)\n\n[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json)](https://github.com/copier-org/copier)\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/copier-org/copier)\n[![codecov](https://codecov.io/gh/copier-org/copier/branch/master/graph/badge.svg)](https://codecov.io/gh/copier-org/copier)\n[![CI](https://github.com/copier-org/copier/workflows/CI/badge.svg)](https://github.com/copier-org/copier/actions?query=branch%3Amaster)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n![Python](https://img.shields.io/pypi/pyversions/copier?logo=python\u0026logoColor=%23959DA5)\n[![PyPI](https://img.shields.io/pypi/v/copier?logo=pypi\u0026logoColor=%23959DA5)](https://pypi.org/project/copier/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Documentation Status](https://img.shields.io/readthedocs/copier/latest?logo=readthedocs)](https://copier.readthedocs.io/en/latest)\n[![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20Copier%20Guru-006BFF)](https://gurubase.io/g/copier)\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![Sample output](https://github.com/copier-org/copier/raw/master/img/copier-output.png)\n\n## Installation\n\n1. Install Python 3.10 or newer.\n1. Install Git 2.27 or newer.\n1. To use as a CLI app: [`pipx install copier`](https://github.com/pypa/pipx) or\n   [`uv tool install copier`](https://docs.astral.sh/uv/#tool-management)\n1. To use as a library: `pip install copier` or `conda install -c conda-forge copier`\n\n### Homebrew formula\n\nTo install the latest Copier release using\n[its Homebrew formula](https://formulae.brew.sh/formula/copier) for macOS or Linux:\n\n```shell\nbrew install copier\n```\n\n## Quick start\n\nTo create a template:\n\n```shell\n📁 my_copier_template                        # your template project\n├── 📄 copier.yml                            # your template configuration\n├── 📁 .git/                                 # your template is a Git repository\n├── 📁 {{project_name}}                      # a folder with a templated name\n│   └── 📄 {{module_name}}.py.jinja          # a file with a templated name\n└── 📄 {{_copier_conf.answers_file}}.jinja   # answers are recorded here\n```\n\nContent of the `copier.yml` file:\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\nContent of the `{{project_name}}/{{module_name}}.py.jinja` file:\n\n```python+jinja title=\"{{project_name}}/{{module_name}}.py.jinja\"\nprint(\"Hello from {{module_name}}!\")\n```\n\nContent of the `{{_copier_conf.answers_file}}.jinja` file:\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](\u003chttps://en.wikipedia.org/wiki/Scaffold_(programming)\u003e)**. 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! 🏷\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[![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)\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```html\n\u003ca href=\"https://github.com/copier-org/copier\"\u003e\u003cimg 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%;\"/\u003e\u003c/a\u003e\n```\n\n### Copier badge variations\n\n1. Badge Grayscale Border\n    [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-border.json)](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border\n    [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border.json)](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Orange\n    [![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)\n\n1. Badge Grayscale Inverted Border Red\n    [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-red.json)](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Teal\n    [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json)](https://github.com/copier-org/copier)\n\n1. Badge Grayscale Inverted Border Purple\n    [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json)](https://github.com/copier-org/copier)\n\n1. Badge Black\n    [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](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! ⭐\n\n\u003c!-- rumdl-capture --\u003e\n\u003c!-- rumdl-disable MD033 --\u003e\n\u003ca href=\"https://star-history.com/#copier-org/copier\u0026Date\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=copier-org/copier\u0026type=Date\u0026theme=dark\" /\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=copier-org/copier\u0026type=Date\" /\u003e\n    \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=copier-org/copier\u0026type=Date\" /\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003c!-- rumdl-restore --\u003e\n","funding_links":["https://github.com/sponsors/Yajo"],"categories":["Python","Development","命令行工具","python","Command-line Tools","⚙️ DevOps \u0026 CI/CD","Others","Templating"],"sub_categories":["Time Series","📰 Blogs","Projects templating"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcopier-org%2Fcopier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcopier-org%2Fcopier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcopier-org%2Fcopier/lists"}