一些诗歌插件集合
项目描述
Poem Plugins
一套为Poetry提供的插件。
如何使用
确保您有Poetry版本1.4.0或更高版本。如果您还没有安装它，请阅读下面的安装说明。
安装Poem Plugins
将此插件安装到您的Poetry
poetry self add poem-plugins
版本插件
项目版本控制诗歌插件允许用户通过除默认的pyproject.toml文件之外的方式指定其项目的版本。这对于喜欢根据git标签设置项目版本的用户来说非常有用。
可以通过在pyproject.toml文件中的一个部分来配置插件。要使用插件，您需要向您的pyproject.toml文件中添加一个指定提供者的部分。
以下是您在pyproject.toml文件中配置插件的示例
[tool.poem-plugins.version]
provider = "git"
同样，您可以指定一些可选参数来控制插件的行为。以下是可以使用的部分参数
| 名称 | 描述 | 默认值 |
|---|---|---|
update_pyproject |
插件不仅会使用提供者提供的版本进行构建，还会将其保存在pyproject.toml中 |
false |
write_version_file |
插件将在模块内创建一个version.py文件，其中包含版本信息 |
false |
version_file_quotes |
插件将用提供的：'或"替换version.py文件中的默认引号 |
unset |
您可以在配置中指定特定于提供者的设置。要指定特定于提供者的设置，您可以使用tool.poem-plugins.version.{provider}部分。以下是您可以用于git提供者的部分参数
| 名称 | 描述 | 默认值 |
|---|---|---|
version_prefix |
仅过滤以该前缀开始的标签 | v |
格式 |
插件将使用提交哈希（长）或不使用（短）来构建项目版本 | 短 |
示例
[tool.poem-plugins.version.git]
version_prefix = "v"
format = "short"
要构建您的项目，请运行poetry build命令。插件将通过提供者构建版本，并使用它为项目设置版本。
$ git tag -a v0.1 -m 'tag description'
$ poetry build
poem-plugins: Setting version to: 0.1.0
Building awesome_package (0.1.0)
- Building sdist
- Built awesome_package-0.1.0.tar.gz
- Building wheel
- Built awesome_package-0.1.0-py3-none-any.whl
如何开发
在开始开发之前，您需要安装poetry。
安装poetry后，您可以通过运行以下命令为项目创建一个虚拟环境：
poetry install
这将还会安装项目所需的所有依赖项。
pre-commit钩子
此项目使用pre-commit在提交更改之前自动运行简单的格式化程序gray。要设置pre-commit钩子，请在项目根目录中运行以下命令：
poetry run pre-commit install
类型检查
此项目使用mypy进行类型检查。您可以使用以下命令运行类型检查器：
poetry run mypy poem_plugins
代码风格检查
此项目使用pylama进行代码风格检查。您可以使用以下命令运行代码风格检查器：
poetry run pylama poem_plugins
测试
我们使用pytest进行测试。您可以使用以下命令运行测试：
poetry run pytest
在提交拉取请求之前，请确保所有测试都通过，且代码风格检查器和类型检查器没有报告任何问题。
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分发
构建分发
poem_plugins-1.1.8.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 44705ea8904b6aad3afed60d189875a25d45ff2f16712ebe347fcdac0cfff410 |
|
| MD5 | 405de7a899c122857172dfa6a9c19dee |
|
| BLAKE2b-256 | 89a20937ae9ca74d328f571244b97fa930a33c637e9747a0b5c861433e52fd9b |
poem_plugins-1.1.8-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | e9a5164012688a84dcf982123d45edf9377c55ea68995773c97937ccc2e49738 |
|
| MD5 | c7f03d2051cabbab61550fb8fb911d3a |
|
| BLAKE2b-256 | e862cf3fda6bdb5ba5c869251dba3f99aa2b50b60719d9a4b6bcdf885ae601dc |