attr_utils

Utilities to augment attrs.

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Anaconda

Conda - Package Version Conda - Platform

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status

Installation

python3 -m pip install attr_utils --user

Attention

In v0.6.0 and above the pprinter module requires the pprint extra to be installed:

python -m pip install attr-utils[pprint]

Overview

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

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

extensions = [
    ...
    'sphinx.ext.autodoc',
    'sphinx_toolbox.more_autodoc.typehints',
    'attr_utils.annotations',
    'attr_utils.autoattrs',
    ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .