ezenum

Easy enums for Python.

>>> from ezenum import StringEnum
>>> RGB = StringEnum(['Red', 'Green', 'Blue'])
>>> RGB.Red
    'Red'

Contents

• 1   Installation
• 2   Features
• 3   Use
  • 3.1   StringEnum
• 4   Contributing
  • 4.1   Installing for development
  • 4.2   Running the tests
  • 4.3   Adding documentation
• 5   Credits

1   Installation

Install ezenum with:

pip install ezenum

2   Features

• Pure Python.
• No package dependencies.
• Compatible with Python 3.4+.
• Easy creation of usefull enum objects.
• String enums with unified value and name attributes.

3   Use

3.1   StringEnum

Easilly get a string enum from a string list.

4   Contributing

Package author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help.

4.1   Installing for development

Clone:

git clone git@github.com:shaypal5/ezenum.git

Install in development mode with test dependencies:

cd ezenum
pip install -e ".[test]"

4.2   Running the tests

To run the tests, use:

pytest

If that doesn't work, this should:

python -m pytest --cov=ezenum

4.3   Adding documentation

This project is documented using the numpy docstring conventions, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings (in my personal opinion, of course). When documenting code you add to this project, please follow these conventions.

Additionally, if you update this README.rst file, use python setup.py checkdocs to validate it compiles.

5   Credits

Created by Shay Palachy (shay.palachy@gmail.com).