copier

一个用于渲染项目模板的库和命令行应用。

支持本地路径和Git URL。
您的项目可以包含任何文件，Copier 可以在任何类型的文本文件中动态替换值。
它生成美观的输出，并注意不覆盖现有文件，除非被指示这样做。

示例输出

安装

安装 Python 3.8 或更新版本。
安装 Git 2.27 或更新版本。
作为命令行应用使用：pipx install copier
作为库使用：pip install copier 或 conda install -c conda-forge copier

Nix flake

要安装最新的 Copier 版本，并实现 100% 的可重现性：

nix profile install 'https://flakehub.com/f/copier-org/copier/*.tar.gz'

快速开始

创建模板：

📁 my_copier_template                        # 您的模板项目
├── 📄 copier.yml                            # 您的模板配置
├── 📁 .git/                                 # 您的模板是一个 Git 仓库
├── 📁 {{project_name}}                      # 一个带有模板化名称的文件夹
│   └── 📄 {{module_name}}.py.jinja          # 一个带有模板化名称的文件
└── 📄 {{_copier_conf.answers_file}}.jinja   # 答案记录在这里

# 问题
project_name:
    type: str
    help: 您的项目名称是什么？

module_name:
    type: str
    help: 您的 Python 模块名称是什么？

print("Hello from {{module_name}}!")

# 此处的更改将被 Copier 覆盖
{{ _copier_answers|to_nice_yaml -}}

从模板生成项目：

在命令行中：

copier copy path/to/project/template path/to/destination

或在 Python 代码中，以编程方式：

from copier import run_copy

# 从本地路径创建项目
run_copy("path/to/project/template", "path/to/destination")

# 或从 Git URL 创建
run_copy("https://github.com/copier-org/copier.git", "path/to/destination")

# 您也可以使用 "gh:" 作为 "https://github.com/" 的简写
run_copy("gh:copier-org/copier.git", "path/to/destination")

# 或使用 "gl:" 作为 "https://gitlab.com/" 的简写
run_copy("gl:copier-org/copier.git", "path/to/destination")

基本概念

Copier 由以下主要概念组成：

模板。它们规定了如何生成子项目。
问卷。它们在模板中配置。答案用于生成项目。
项目。这是您真正的程序所在之处。但它通常是从模板生成和/或更新的。

Copier 主要面向以下人群：

模板创建者。重复代码太多的程序员，更喜欢使用工具来完成这项工作。

提示： Copier 并不能替代 DRY 原则...但有时您确实无法做到 DRY，这时您需要一台"干燥机"...
模板使用者。希望快速启动新项目或舒适地发展项目的程序员。只要非人类的期望与人类相同，并且他们有感情，他们也应该通过使用Copier的命令行界面或API而感到高兴。

模板有以下目标：

代码脚手架。帮助用户尽快拥有一个可工作的源代码树。所有模板都支持脚手架功能。
代码生命周期管理。当模板发生变化时，让用户能够更新他们的项目。并非所有模板都支持更新。

Copier尝试提供一个平滑的学习曲线，让你能够创建简单的模板，并根据需要演变成复杂的模板。

浏览或标记公共模板

你可以在GitHub上使用copier-template主题浏览公共Copier模板。可以将它们用作灵感来源！

如果你希望你的模板出现在该列表中，只需为其添加该主题标签即可！🏷

展示你的支持

如果你正在使用Copier，可以考虑在你的项目的README.md中添加Copier徽章：

[![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)

...或者在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

...或者作为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>