pip-preserve-requirements

保留您控制的仓库中的固定pip需求。

它确保pip需求文件中的固定git引用被推送到您控制的仓库，并与提交关联一个标签，从而防止它们被垃圾收集。

目录

• pip-preserve-requirements
  • 安装
  • 用法
  • 配置
  • 限制
  • 许可证

安装

pipx install pip-preserve-requirements

用法

Usage: pip-preserve-requirements [OPTIONS] REQUIREMENTS_FILE...

  Ensure pinned VCS references in pip requirements files have a git tag.

Arguments:
  REQUIREMENTS_FILE...  The requirements files to look for requirements tag.
                        [required]

Options:
  --tag-prefix TEXT               The prefix to use when creating git tag
                                  names.  [default: ppr-]
  --match-any-tag                 Whether to consider that any tag on the
                                  commit is sufficient. If not, ensure commits
                                  are tagged with the requested prefix.
  -r, --project-root DIRECTORY    The project root directory. Default options
                                  and arguments are read from pyproject.toml
                                  in this directory.  [default: .]
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

配置

pip-preserve-requirements配置在pyproject.toml的专用部分。

示例

[tool.pip-preserve-requirements]
tag_prefix = "ppr-"
# ensure a tag with the above prefix is present, if true, consider any tag is valid
match_any_tag = false

[[tool.pip-preserve-requirements.vcs_vaults]]
# any git provider which accepts URLs of the form https://host/owner/repo
# or ssh://git@host/owner/repo
provider = "github.com"
owner = "acme"
# set to true for private repos
ssh_only = false
# the vault where to push VCS reference
default = true

限制

目前，仅支持git+https和git+ssh URL。

以下改进将在范围内考虑，尽管目前没有计划进行这些改进

• 支持其他VCS（如hg）；
• 通过将它们推送到用户控制的服务器来支持非VCS URL；
• 通过将它们推送到用户控制的索引来支持常规需求。

许可证

pip-preserve-requirements在MIT许可证的条款下分发。