jgt-tools 0.2.3

快速启动

只需在包virtualenv中包含jgt_tools， 您可以访问这些CLI调用：

• env-setup-设置开发环境 包含所有包和预提交检查
• self-check-在存储库上运行自检/linters/etc.
• run-tests-运行回购测试套件
• build-docs-在本地生成回购文档
• build-and-push-docs-两者都生成文档， 然后发布到您的gh pages分支
• check-version-如果包相关文件已更改，则引发错误 无版本凹凸

通过使用--help标志调用可以找到每个脚本的详细信息。

文档索引

为了从build-docs中获得全部好处， 鼓励创建索引文件 所有的文件都在一起。 此文件需要在根文件夹中 应该被称为.jgt_tools.index。 这将被移到sphinx的工作目录中 并在构建文档时使用。 可以在Sphinx site上找到其他信息。

配置

要调用的操作数 可以在^{tt11}中自定义$ 在您的pyproject.toml文件中。 可用值为：

• env_setup_commands-要运行的命令列表 在env-setup调用下
• self_check_commands-要运行的命令列表 在self-check调用下
• run_tests_commands-要运行的命令列表 在run-tests调用下
• doc_build_types-文档构造的类型列表： -api是当前唯一受支持的选项

例如：

[tool.jgt_tools]
env_setup_commands = [
    "poetry install",
    "poetry run pip install other_package",
    "./my_custom_setup_script.sh"
]
doc_build_types = []

将为^{tt2}运行指定的命令$ 跳过apidoc生成器。

另外， 用于验证哪些文件与^{tt7}相关的函数$ 可定制。 默认情况下，如果diff中针对master的任何文件是.py文件， 预计会出现版本冲突， 但是用户可以提供一个替代函数来验证文件名

函数应该期望字符串列表 表示相对于项目根目录的文件路径 （由git diff master --name-only提供） 并返回一个布尔值，表示是否应确保版本更改 （即True如果应检查版本）

这可以注册为pyproject.toml文件中的插件：

[tools.poetry.plugins."file_checkers"]
"version_trigger" = "my_module:my_function"

或者在setup.py文件中：

setup(
    ...
    entry_points={
        "version_trigger": ["version_trigger = my_module:my_fuction"]
    }
)