Copier 项目技术文档

1. 安装指南

1.1 环境要求

• Python 3.9 或更新版本
• Git 2.27 或更新版本

1.2 安装方式

1.2.1 使用 pipx 安装（推荐）

pipx install copier

1.2.2 使用 pip 安装

pip install copier

1.2.3 使用 conda 安装

conda install -c conda-forge copier

1.2.4 使用 Nix flake 安装

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

2. 项目的使用说明

2.1 创建模板

要创建一个模板，您需要按照以下结构组织您的模板项目：

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

2.2 配置模板

在 copier.yml 文件中配置问题：

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

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

2.3 生成项目

2.3.1 命令行生成

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

2.3.2 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")

3. 项目API使用文档

3.1 run_copy 函数

run_copy 函数用于从模板生成项目。它支持从本地路径或 Git URL 生成项目。

3.1.1 参数

• src_path: 模板路径（可以是本地路径或 Git URL）
• dst_path: 目标路径（生成的项目将放置在此路径）

3.1.2 示例

from copier import run_copy

run_copy("path/to/project/template", "path/to/destination")

4. 项目安装方式

4.1 使用 pipx 安装

pipx install copier

4.2 使用 pip 安装

pip install copier

4.3 使用 conda 安装

conda install -c conda-forge copier

4.4 使用 Nix flake 安装

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

通过以上步骤，您可以轻松安装和使用 Copier 项目，创建和管理项目模板。