跳转到主要内容

用于编写构建脚本的Hatch插件

项目描述

Hatch Build Scripts

一个用于Hatch的插件,允许您运行任意构建脚本并将它们的工件包含在您的软件包分发中。

安装

要将配置到您的项目中,您需要在项目的pyproject.toml文件中将其配置为build-system需求。

[build-system]
requires = ["hatchling", "hatch-build-scripts"]
build-backend = "hatchling.build"

使用方法

现在您需要配置要运行的构建脚本。这是通过在您的pyproject.toml文件中将脚本数组添加到tool.hatch.build.hooks.build-scripts.scripts键来完成的。每个脚本都使用以下键进行配置

默认值 描述
commands 必需 要运行的命令数组。每个命令都在单独的shell中运行。
artifacts 必需 要包含在您的软件包分发中的工件模式数组(与.gitignore相同)。
out_dir "." 将工件复制的目录。
work_dir "." 运行命令的目录。所有工件模式都是相对于此目录的。
clean_artifacts true 在运行命令之前是否从out_dir中清理与工件模式匹配的文件。
clean_out_dir false 在运行命令之前是否清理out_dir

在实际中,这看起来像

[[tool.hatch.build.hooks.build-scripts.scripts]]
out_dir = "out"
commands = [
    "echo 'Hello, world!' > hello.txt",
    "echo 'Goodbye, world!' > goodbye.txt",
]
artifacts = [
    "hello.txt",
    "goodbye.txt",
]

[[tool.hatch.build.hooks.build-scripts.scripts]]
# you can add more scripts here...

您可以通过在pyproject.toml文件中添加一个[tool.hatch.build.hooks.build-scripts]表来配置脚本的默认值。以下键受支持

默认值 描述
out_dir "." 将工件复制的目录。
work_dir "." 运行命令的目录。所有工件模式都是相对于此目录的。
clean_artifacts true 在运行命令之前是否从out_dir中清理与工件模式匹配的文件。
clean_out_dir false 在运行命令之前是否清理out_dir

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

hatch_build_scripts-0.0.4.tar.gz (8.7 kB 查看哈希值)

上传时间

构建分布

hatch_build_scripts-0.0.4-py3-none-any.whl (5.3 kB 查看哈希值)

上传时间 Python 3

支持者