pyproject_patcher.tools.setuptools_git_versioning
=================================================

.. py:module:: pyproject_patcher.tools.setuptools_git_versioning

.. autoapi-nested-parse::

   Manage the `setuptools_git_versioning` tool in a `pyproject.toml`.



Attributes
----------

.. autoapisummary::

   pyproject_patcher.tools.setuptools_git_versioning.TOOL_NAME


Classes
-------

.. autoapisummary::

   pyproject_patcher.tools.setuptools_git_versioning.SetuptoolsGitVersioning


Module Contents
---------------

.. py:data:: TOOL_NAME
   :value: 'setuptools-git-versioning'


.. py:class:: 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.


   .. py:attribute:: patcher
      :type:  pyproject_patcher.patcher.PyprojectPatcher


   .. py:method:: 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.



   .. py:method:: 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.