============
Enum Tools
============
.. start short_desc
**Tools to expand Python's enum module.**
.. 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/enum-tools/latest?logo=read-the-docs
:target: https://enum-tools.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/enum_tools/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/enum_tools/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/enum_tools/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/enum_tools/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/enum_tools/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/enum_tools/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/enum_tools/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/enum_tools/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/enum_tools/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/enum_tools?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/enum_tools?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/enum_tools
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/enum_tools
:target: https://pypi.org/project/enum_tools/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/enum_tools?logo=python&logoColor=white
:target: https://pypi.org/project/enum_tools/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/enum_tools
:target: https://pypi.org/project/enum_tools/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/enum_tools
:target: https://pypi.org/project/enum_tools/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/conda-forge/enum_tools?logo=anaconda
:target: https://anaconda.org/conda-forge/enum_tools
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/conda-forge/enum_tools?label=conda%7Cplatform
:target: https://anaconda.org/conda-forge/enum_tools
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/domdfcoding/enum_tools
:target: https://github.com/domdfcoding/enum_tools/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/enum_tools
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/enum_tools/v0.12.0
:target: https://github.com/domdfcoding/enum_tools/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/enum_tools
:target: https://github.com/domdfcoding/enum_tools/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/enum_tools
:target: https://pypi.org/project/enum_tools/
:alt: PyPI - Downloads
.. end shields
This library provides the following:
#. ``enum_tools.autoenum`` – A `Sphinx <https://www.sphinx-doc.org>`_ extension to document Enums better than ``autoclass``
can currently.
#. ``@enum_tools.documentation.document_enum`` – A decorator to add docstrings to ``Enum`` members
from a comment at the end of the line.
#. ``enum_tools.custom_enums`` – Additional ``Enum`` classes with different functionality.
Installation
--------------
.. start installation
``enum_tools`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install enum_tools
To install with ``conda``:
.. code-block:: bash
$ conda install -c conda-forge enum_tools
.. end installation
Further Reading
-----------------------
#. https://docs.python.org/3/library/enum.html
#. `Is it possible to define a class constant inside an Enum? <https://stackoverflow.com/q/17911188/3092681>`_
#. `Enums with Attributes <https://stackoverflow.com/a/19300424/3092681>`_
#. `When should I subclass EnumMeta instead of Enum? <https://stackoverflow.com/a/43730306/3092681>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/domdfcoding/enum_tools",
"name": "enum-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "documentation, enum, sphinx, sphinx-extension",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/94/06/55dfd19df0386a2a90d325dba67b0b5ba0b879a4bdac9cd225c22f6736d8/enum_tools-0.12.0.tar.gz",
"platform": "Windows",
"description": "\n============\nEnum Tools\n============\n\n.. start short_desc\n\n**Tools to expand Python's enum module.**\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/enum-tools/latest?logo=read-the-docs\n\t:target: https://enum-tools.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/enum_tools/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/enum_tools/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/enum_tools/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/enum_tools/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/enum_tools/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/enum_tools/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/enum_tools/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/enum_tools/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/enum_tools/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/enum_tools/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/enum_tools?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/enum_tools?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/enum_tools\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/enum_tools\n\t:target: https://pypi.org/project/enum_tools/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/enum_tools?logo=python&logoColor=white\n\t:target: https://pypi.org/project/enum_tools/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/enum_tools\n\t:target: https://pypi.org/project/enum_tools/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/enum_tools\n\t:target: https://pypi.org/project/enum_tools/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/conda-forge/enum_tools?logo=anaconda\n\t:target: https://anaconda.org/conda-forge/enum_tools\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/conda-forge/enum_tools?label=conda%7Cplatform\n\t:target: https://anaconda.org/conda-forge/enum_tools\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/enum_tools\n\t:target: https://github.com/domdfcoding/enum_tools/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/enum_tools\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/enum_tools/v0.12.0\n\t:target: https://github.com/domdfcoding/enum_tools/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/enum_tools\n\t:target: https://github.com/domdfcoding/enum_tools/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/enum_tools\n\t:target: https://pypi.org/project/enum_tools/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n\nThis library provides the following:\n\n#. ``enum_tools.autoenum`` \u2013 A `Sphinx <https://www.sphinx-doc.org>`_ extension to document Enums better than ``autoclass``\n can currently.\n#. ``@enum_tools.documentation.document_enum`` \u2013 A decorator to add docstrings to ``Enum`` members\n from a comment at the end of the line.\n#. ``enum_tools.custom_enums`` \u2013 Additional ``Enum`` classes with different functionality.\n\n\nInstallation\n--------------\n\n.. start installation\n\n``enum_tools`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install enum_tools\n\nTo install with ``conda``:\n\n.. code-block:: bash\n\n\t$ conda install -c conda-forge enum_tools\n\n.. end installation\n\n\nFurther Reading\n-----------------------\n\n#. https://docs.python.org/3/library/enum.html\n\n#. `Is it possible to define a class constant inside an Enum? <https://stackoverflow.com/q/17911188/3092681>`_\n\n#. `Enums with Attributes <https://stackoverflow.com/a/19300424/3092681>`_\n\n#. `When should I subclass EnumMeta instead of Enum? <https://stackoverflow.com/a/43730306/3092681>`_\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "Tools to expand Python's enum module.",
"version": "0.12.0",
"project_urls": {
"Documentation": "https://enum-tools.readthedocs.io/en/latest",
"Homepage": "https://github.com/domdfcoding/enum_tools",
"Issue Tracker": "https://github.com/domdfcoding/enum_tools/issues",
"Source Code": "https://github.com/domdfcoding/enum_tools"
},
"split_keywords": [
"documentation",
" enum",
" sphinx",
" sphinx-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75fccc600677fe58519352ae5fe9367d05d0054faa47e8c57ef50a1bb9c77b0e",
"md5": "e6a7f159f9199374afecbcc35d2645a2",
"sha256": "d69b019f193c7b850b17d9ce18440db7ed62381571409af80ccc08c5218b340a"
},
"downloads": -1,
"filename": "enum_tools-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6a7f159f9199374afecbcc35d2645a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 22356,
"upload_time": "2024-04-02T17:55:40",
"upload_time_iso_8601": "2024-04-02T17:55:40.688280Z",
"url": "https://files.pythonhosted.org/packages/75/fc/cc600677fe58519352ae5fe9367d05d0054faa47e8c57ef50a1bb9c77b0e/enum_tools-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "940655dfd19df0386a2a90d325dba67b0b5ba0b879a4bdac9cd225c22f6736d8",
"md5": "8abd038e85f5392286242932c405ba0c",
"sha256": "13ceb9376a4c5f574a1e7c5f9c8eb7f3d3fbfbb361cc18a738df1a58dfefd460"
},
"downloads": -1,
"filename": "enum_tools-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "8abd038e85f5392286242932c405ba0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18931,
"upload_time": "2024-04-02T17:55:42",
"upload_time_iso_8601": "2024-04-02T17:55:42.733176Z",
"url": "https://files.pythonhosted.org/packages/94/06/55dfd19df0386a2a90d325dba67b0b5ba0b879a4bdac9cd225c22f6736d8/enum_tools-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 17:55:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "domdfcoding",
"github_project": "enum_tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pygments",
"specs": [
[
">=",
"2.6.1"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"3.7.4.3"
]
]
}
],
"tox": true,
"lcname": "enum-tools"
}
JSON
