index.rst

attr_utils

Utilities to augment attrs.

Docs	|docs| |docs_check|
Tests	|travis| |actions_windows| |actions_macos| |coveralls| |codefactor|
PyPI	|pypi-version| |supported-versions| |supported-implementations| |wheel|
Activity	|commits-latest| |commits-since| |maintained|
Other	|license| |language| |requires| |pre_commit|

rtfd-shield::
        :project: attr_utils
        :alt: Documentation Build Status

actions-shield::
        :workflow: Docs Check
        :alt: Docs Check Status

travis-shield::
        :travis-site: com
        :alt: Travis Build Status

actions-shield::
        :workflow: Windows Tests
        :alt: Windows Tests Status

actions-shield::
        :workflow: macOS Tests
        :alt: macOS Tests Status

requires-io-shield::
        :alt: Requirements Status

coveralls-shield::
        :alt: Coverage

codefactor-shield::
        :alt: CodeFactor Grade

pypi-shield::
        :project: attr_utils
        :version:
        :alt: PyPI - Package Version

pypi-shield::
        :project: attr_utils
        :py-versions:
        :alt: PyPI - Supported Python Versions

pypi-shield::
        :project: attr_utils
        :implementations:
        :alt: PyPI - Supported Implementations

pypi-shield::
        :project: attr_utils
        :wheel:
        :alt: PyPI - Wheel

github-shield::
        :license:
        :alt: License

github-shield::
        :top-language:
        :alt: GitHub top language

github-shield::
        :commits-since: v0.1.0
        :alt: GitHub commits since tagged version

github-shield::
        :last-commit:
        :alt: GitHub last commit

maintained-shield:: 2020
        :alt: Maintenance

pre-commit-shield::
        :alt: pre-commit

Installation

.. installation:: attr_utils
        :pypi:
        :github:

attr_utils provides both utility functions and two Sphinx extensions: :mod:`attr_utils.annotations` and :mod:`attr_utils.autoattrs`.

Enable the extensions by adding the following to the extensions variable in your conf.py:

.. extensions:: attr_utils.autoattrs
        :no-preamble:

        sphinx.ext.autodoc
        sphinx_toolbox.more_autodoc.typehints
        attr_utils.annotations

.. toctree::
        :hidden:

        Home<self>

.. toctree::
        :maxdepth: 3
        :caption: API Reference
        :glob:

        api/*

.. toctree::
        :maxdepth: 3
        :caption: Contributing

        contributing
        Source

View the :ref:`Function Index <genindex>` or browse the Source Code.

Browse the GitHub Repository