如何通过setup.py实现文件复制重命名，将配置模板部署至指定包目录

推荐通过自定义setuptools构建命令的方式实现，逻辑完全可控，不需要依赖MANIFEST的重命名能力：

方案1：重载build_py构建命令（推荐） #

直接在你的setup.py中加入如下逻辑即可实现执行构建时自动复制重命名模板文件：

import os
import shutil
from setuptools import setup, find_packages
from setuptools.command.build_py import build_py

class CustomBuildCommand(build_py):
    def run(self):
        # 先执行默认构建逻辑
        super().run()
        # 定义源模板文件路径
        src_file = os.path.join(os.path.dirname(__file__), "config_template.json")
        # 此处替换为你实际的包目录名称
        target_file = os.path.join(os.path.dirname(__file__), "your_package_dir", "config.json")
        # 仅当目标配置不存在时复制，避免覆盖用户已经修改好的本地配置
        if os.path.exists(src_file) and not os.path.exists(target_file):
            shutil.copy(src_file, target_file)

setup(
    name="your-package-name",
    version="0.1",
    packages=find_packages(),
    cmdclass={
        "build_py": CustomBuildCommand
    },
    # 其余你的setup配置项保持不变即可
)

该方案的优势：

• 完全和python setup.py执行流程绑定，只要运行构建/安装命令就会自动触发复制逻辑
• 目标路径可自由调整，适配不同的包目录结构
• 不会冲突现有gitignore规则，生成的config.json不会被提交到仓库

方案2：MANIFEST.in + 安装后钩子 #

如果你习惯用MANIFEST管理额外文件，可以先在MANIFEST.in中添加一行include config_template.json将模板文件纳入打包列表，再按照上述重载命令的逻辑，重载install命令类在安装阶段完成复制重命名即可。

注意事项 #

建议同步将包目录下的config.json也添加到.gitignore中，避免用户本地生成的配置被误提交。

内容的提问来源于stack exchange，提问作者MaKaNu