attr-utils


Nameattr-utils JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/domdfcoding/attr_utils
SummaryUtilities to augment attrs.
upload_time2024-06-25 14:52:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT
keywords attrs documentation serde sphinx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
###########
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]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/domdfcoding/attr_utils",
    "name": "attr-utils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "attrs, documentation, serde, sphinx",
    "author": null,
    "author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
    "download_url": "https://files.pythonhosted.org/packages/b5/4f/e8932c257c5e6e7cd440e038125b18efc0ab6455af7b4bbf8fd23e3e5f21/attr_utils-1.1.0.tar.gz",
    "platform": "Windows",
    "description": "\n###########\nattr_utils\n###########\n\n.. start short_desc\n\n**Utilities to augment attrs.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t  - |docs| |docs_check|\n\t* - Tests\n\t  - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t  - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t  - |conda-version| |conda-platform|\n\t* - Activity\n\t  - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t  - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t  - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/attr-utils/latest?logo=read-the-docs\n\t:target: https://attr-utils.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/attr_utils/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/attr_utils/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/attr_utils/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/attr_utils/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/attr_utils/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/attr_utils/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/attr_utils/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/attr_utils/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/attr_utils/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/attr_utils/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/attr_utils?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/attr_utils?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/attr_utils\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/attr_utils\n\t:target: https://pypi.org/project/attr_utils/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/attr_utils?logo=python&logoColor=white\n\t:target: https://pypi.org/project/attr_utils/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/attr_utils\n\t:target: https://pypi.org/project/attr_utils/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/attr_utils\n\t:target: https://pypi.org/project/attr_utils/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/attr_utils?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/attr_utils\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/attr_utils?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/attr_utils\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/attr_utils\n\t:target: https://github.com/domdfcoding/attr_utils/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/attr_utils\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/attr_utils/v1.1.0\n\t:target: https://github.com/domdfcoding/attr_utils/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/attr_utils\n\t:target: https://github.com/domdfcoding/attr_utils/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/attr_utils\n\t:target: https://pypi.org/project/attr_utils/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n|\n\nInstallation\n--------------\n\n.. start installation\n\n``attr_utils`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install attr_utils\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install attr_utils\n\n.. end installation\n\n.. attention::\n\n\tIn v0.6.0 and above the ``pprinter`` module requires the ``pprint`` extra to be installed:\n\n\t.. code-block:: bash\n\n\t\t$ python -m pip install attr-utils[pprint]\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Utilities to augment attrs.",
    "version": "1.1.0",
    "project_urls": {
        "Documentation": "https://attr-utils.readthedocs.io/en/latest",
        "Homepage": "https://github.com/domdfcoding/attr_utils",
        "Issue Tracker": "https://github.com/domdfcoding/attr_utils/issues",
        "Source Code": "https://github.com/domdfcoding/attr_utils"
    },
    "split_keywords": [
        "attrs",
        " documentation",
        " serde",
        " sphinx"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c1855b08bc252c78bb455472ffe98145d5efac95be2e2759f71b11ce345829ac",
                "md5": "3d4e147cbcbba3e0faa7a9b2f6d237c7",
                "sha256": "0e40ec1fdb96bf8c6c529a34570e94f2b6c16be626559a5e852362ef7e893432"
            },
            "downloads": -1,
            "filename": "attr_utils-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3d4e147cbcbba3e0faa7a9b2f6d237c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 25221,
            "upload_time": "2024-06-25T14:52:50",
            "upload_time_iso_8601": "2024-06-25T14:52:50.786143Z",
            "url": "https://files.pythonhosted.org/packages/c1/85/5b08bc252c78bb455472ffe98145d5efac95be2e2759f71b11ce345829ac/attr_utils-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b54fe8932c257c5e6e7cd440e038125b18efc0ab6455af7b4bbf8fd23e3e5f21",
                "md5": "dd2a070fbe2fb8cf5911dd0ca2f1af9c",
                "sha256": "5d1100e3ac5807aad40f378839e150ce30605bfce520c93522b17ba01356ee50"
            },
            "downloads": -1,
            "filename": "attr_utils-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "dd2a070fbe2fb8cf5911dd0ca2f1af9c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 17566,
            "upload_time": "2024-06-25T14:52:52",
            "upload_time_iso_8601": "2024-06-25T14:52:52.614282Z",
            "url": "https://files.pythonhosted.org/packages/b5/4f/e8932c257c5e6e7cd440e038125b18efc0ab6455af7b4bbf8fd23e3e5f21/attr_utils-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-25 14:52:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "domdfcoding",
    "github_project": "attr_utils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "attr-utils"
}
        
Elapsed time: 3.54288s