plumbus 0.0.2

Easy enums for python.

Easy enums for Python.

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

Contents

• 1 Installation

• 2 Features

• 3 Use

• 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.

• Compatible with Python 3.5+.

• Easy creation of usefull enum objects.

• String enums with unified value and name attributes.

3 Use

StringEnum

Easilly get a string enum from a string list.

4 Contributing

Package author and current maintainer is Shay Palachy ([e-mail]); You are more than welcome to approach him for help.

4.1 Installing for development

Clone:

git clone [e-mail]: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:

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.

5 Credits

Created by Shay Palachy ([e-mail]).