pyproject_patcher.tools.setuptools_git_versioning

Manage the setuptools_git_versioning tool in a pyproject.toml.

Attributes

TOOL_NAME

Classes

SetuptoolsGitVersioning

This class wraps a pyproject.toml model and provides

Module Contents

pyproject_patcher.tools.setuptools_git_versioning.TOOL_NAME = 'setuptools-git-versioning'

class pyproject_patcher.tools.setuptools_git_versioning.SetuptoolsGitVersioning

This class wraps a pyproject.toml model and provides methods to interact with the tools.setuptools_git_versioning part and other entries related to it.

patcher: pyproject_patcher.patcher.PyprojectPatcher

remove()

Removes all references to setuptools-git-versioning from this model. This includes removal of the dynamic = [“version”] entry and the entry in the build-system.requires section that requires the setuptools-git-versioning module.

Return type:

None

template_ignore_dirty_git()

Changes dirty_template so that it no longer contains a .dirty suffix.

Useful for building system packages based on a VCS revision checked out with Git in cases where pyproject.toml has been modified before setuptools_git_versioning is run. In that case, having a .dirty suffix would be misleading.

Return type:

None