Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/domdfcoding/attr_utils
Utilities to augment attrs.
https://github.com/domdfcoding/attr_utils
attrs documentation python serde sphinx
Last synced: 21 days ago
JSON representation
Utilities to augment attrs.
- Host: GitHub
- URL: https://github.com/domdfcoding/attr_utils
- Owner: domdfcoding
- License: mit
- Created: 2020-08-14T21:05:09.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T15:33:31.000Z (3 months ago)
- Last Synced: 2024-09-22T22:15:24.176Z (about 1 month ago)
- Topics: attrs, documentation, python, serde, sphinx
- Language: HTML
- Homepage: https://attr-utils.readthedocs.io/en/latest
- Size: 573 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
###########
attr_utils
###########
.. start short_desc
**Utilities to augment attrs.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/attr-utils/latest?logo=read-the-docs
:target: https://attr-utils.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/attr_utils/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/attr_utils/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/attr_utils/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/attr_utils/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/attr_utils/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/attr_utils/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/attr_utils/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/attr_utils/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/attr_utils/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/attr_utils?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/attr_utils?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/attr_utils
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/attr_utils
:target: https://pypi.org/project/attr_utils/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/attr_utils?logo=python&logoColor=white
:target: https://pypi.org/project/attr_utils/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/attr_utils
:target: https://pypi.org/project/attr_utils/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/attr_utils
:target: https://pypi.org/project/attr_utils/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/attr_utils?logo=anaconda
:target: https://anaconda.org/domdfcoding/attr_utils
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/attr_utils?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/attr_utils
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/domdfcoding/attr_utils
:target: https://github.com/domdfcoding/attr_utils/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/attr_utils
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/attr_utils/v1.1.0
:target: https://github.com/domdfcoding/attr_utils/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/attr_utils
:target: https://github.com/domdfcoding/attr_utils/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/attr_utils
:target: https://pypi.org/project/attr_utils/
:alt: PyPI - Downloads
.. end shields
|
Installation
--------------
.. start installation
``attr_utils`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install attr_utils
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install attr_utils
.. end installation
.. attention::
In v0.6.0 and above the ``pprinter`` module requires the ``pprint`` extra to be installed:
.. code-block:: bash
$ python -m pip install attr-utils[pprint]