飞轮齿轮开发工具
flywheel-gear-toolkit的Python项目详细描述
飞轮齿轮工具箱
flywheel gear toolkit是一个为开发飞轮齿轮提供工具的库。在
安装
pip install flywheel-gear-toolkit
如果您还想安装geartk
,请运行gear toolkit CLI:
这将安装其他依赖项。在
文件
可以找到flywheel gear工具箱的文档here。在
贡献
建筑物
gear工具箱的依赖关系和虚拟环境管理器是poetry。在
poetry install
测试
可以使用tests.sh
脚本在
运行诗歌安装:
poetry run tests/bin/tests.sh
管理依赖项
若要向此repo添加新的依赖项,请使用poetry 并遵循以下步骤:
# Install my-package:
poetry add my-package
# or install my-package as part of the required packages for development (e.g. pytest):
poetry add my-package --dev
# Sync poetry.lock
poetry lock
建立和释放
当地建筑
要在本地生成项目并验证生成是否成功,可以运行
poetry build --format wheel
twine check dist/*.whl
版本控制和项目信息
pyproject.toml
文件已取代了此存储库中常用的setup.py
,并包含有关贡献者、维护者、项目描述、项目URL和项目版本的信息。为了更改项目的任何信息,必须在pyproject.toml
,文件中进行更改。可以在here找到此文件的文档,可以在here中找到有关依赖项版本规范语法的信息
用于标记和发布的CI
有CI的地方,以帮助标记和发布版本和热修复飞轮齿轮工具包。在
自动标记(尚未启用)
当包含单词“release”的提交被推送到以“hotfix-”开头的master或分支,并且pyproject.toml项目文件(如版本),gitlab CI将自动签出修复/发布,并用当前中找到的标记标记标记分支pyproject.toml项目版本,并按下标签。在
自动发布
当手动或通过以前的自动标记CI推送标记时,将触发发布作业,该作业将自动构建项目控制盘并将版本推送到PYPI。在
- 项目
标签: