Installation
============

.. _install:

There are multiple options to install ``g-docformatter``:


Pre-commit
----------

The package may be used as a pre-commit hook (recommended):

Add the following to your ``.pre-commit-config.yaml``:

.. code-block:: yaml
  :caption: .pre-commit-config.yaml

    - hooks:
      - id: google_docformatter
      repo: https://gitea.digital-architects.net/Repo-Tools/g-docformatter
      rev: <version>  # Substitute <version> with the desired tag or commit hash


Poetry
------

The package may be used as a development dependency:

.. code-block:: bash

    poetry add g-docformatter --group dev