# described-enum
Python Enums with description property
## Install
With pip:
```bash
pip install described-enum
```
With uv:
```bash
uv add described-enum
```
With poetry:
```bash
poetry add described-enum
```
## Classes
* `DescribedEnum` – child class of `enum.Enum`
* `DescribedIntEnum` – child class of `enum.IntEnum`
* `DescribedStrEnum` – child class of `enum.StrEnum`
## Usage examples
```python
from described_enum import DescribedIntEnum, DescribedStrEnum
class TaskStatus(DescribedIntEnum):
PENDING = 1, 'Task was created / enqueued'
RUNNING = 2, 'Working on the task'
DONE = 3, 'Success'
FAILED = 4, 'Task failed'
print(TaskStatus.RUNNING.name) # will print str 'RUNNING'
print(TaskStatus.RUNNING.value) # will print int 2
print(TaskStatus.RUNNING.description) # will print str 'Working on the task'
class Format(DescribedStrEnum):
XML = 'xml', 'Extensible Markup Language'
JSON = 'json', 'JavaScript Object Notation'
TOML = 'toml', "Tom's Obvious, Minimal Language"
YAML = 'yml', "YAML Ain't Markup Language"
print(Format.YAML.name) # will print str 'YAML'
print(Format.YAML.value) # will print str 'yml'
print(Format.YAML.description) # will print str "YAML Ain't Markup Language"
```
Raw data
{
"_id": null,
"home_page": null,
"name": "described-enum",
"maintainer": "Mikhail Shagov",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Mikhail Shagov <mishaga@me.com>",
"keywords": "enum, enums, described enum, enum with description",
"author": "Mikhail Shagov",
"author_email": "Mikhail Shagov <mishaga@me.com>",
"download_url": "https://files.pythonhosted.org/packages/83/f5/257de6ecad7d09c57040ae243afda905e5b83d6347cca5c409fed3a6a232/described_enum-0.0.1.tar.gz",
"platform": null,
"description": "# described-enum\n\nPython Enums with description property\n\n\n## Install\n\nWith pip:\n\n```bash\npip install described-enum\n```\n\nWith uv:\n\n```bash\nuv add described-enum\n```\n\nWith poetry:\n\n```bash\npoetry add described-enum\n```\n\n\n## Classes\n\n* `DescribedEnum` \u2013 child class of `enum.Enum`\n* `DescribedIntEnum` \u2013 child class of `enum.IntEnum`\n* `DescribedStrEnum` \u2013 child class of `enum.StrEnum`\n\n\n## Usage examples\n\n```python\nfrom described_enum import DescribedIntEnum, DescribedStrEnum\n\n\nclass TaskStatus(DescribedIntEnum):\n PENDING = 1, 'Task was created / enqueued'\n RUNNING = 2, 'Working on the task'\n DONE = 3, 'Success'\n FAILED = 4, 'Task failed'\n\n\nprint(TaskStatus.RUNNING.name) # will print str 'RUNNING'\nprint(TaskStatus.RUNNING.value) # will print int 2\nprint(TaskStatus.RUNNING.description) # will print str 'Working on the task'\n\n\nclass Format(DescribedStrEnum):\n XML = 'xml', 'Extensible Markup Language'\n JSON = 'json', 'JavaScript Object Notation'\n TOML = 'toml', \"Tom's Obvious, Minimal Language\"\n YAML = 'yml', \"YAML Ain't Markup Language\"\n\n\nprint(Format.YAML.name) # will print str 'YAML'\nprint(Format.YAML.value) # will print str 'yml'\nprint(Format.YAML.description) # will print str \"YAML Ain't Markup Language\"\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Enums with description property",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/mishaga/described-enum",
"Issues": "https://github.com/mishaga/described-enum/issues",
"Repository": "https://github.com/mishaga/described-enum"
},
"split_keywords": [
"enum",
" enums",
" described enum",
" enum with description"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "41792928081ce0d8d829341ac4630df74d8d62ad5e7e1debd556ffea3b8b2b39",
"md5": "924748bcae8cc63d180a3f7256ec6a82",
"sha256": "59dbe73ea0a92e578d30bfb8f26bb8d8d92f0022349b173eadd6b1cdc452b4d8"
},
"downloads": -1,
"filename": "described_enum-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "924748bcae8cc63d180a3f7256ec6a82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 3679,
"upload_time": "2025-08-17T01:43:21",
"upload_time_iso_8601": "2025-08-17T01:43:21.865170Z",
"url": "https://files.pythonhosted.org/packages/41/79/2928081ce0d8d829341ac4630df74d8d62ad5e7e1debd556ffea3b8b2b39/described_enum-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "83f5257de6ecad7d09c57040ae243afda905e5b83d6347cca5c409fed3a6a232",
"md5": "5d4f038b7cb8718bdb127bb64ebd4fdb",
"sha256": "984554834ef702546f5abba29642b0c0e9c20716935f3837fa17916f49168a88"
},
"downloads": -1,
"filename": "described_enum-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5d4f038b7cb8718bdb127bb64ebd4fdb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 2476,
"upload_time": "2025-08-17T01:43:22",
"upload_time_iso_8601": "2025-08-17T01:43:22.832466Z",
"url": "https://files.pythonhosted.org/packages/83/f5/257de6ecad7d09c57040ae243afda905e5b83d6347cca5c409fed3a6a232/described_enum-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-17 01:43:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mishaga",
"github_project": "described-enum",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "described-enum"
}
JSON
