valve


Namevalve JSON
Version 0.0.0 PyPI version JSON
download
home_pagehttps://github.com/shaypal5/ezenum
SummaryGreat package.
upload_time2018-03-13 16:19:02
maintainer
docs_urlNone
authorShay Palachy
requires_python
licenseMIT
keywords enum
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            ezenum
######
|PyPI-Status| |PyPI-Versions| |Build-Status| |Codecov| |LICENCE|

Easy enums for Python.

.. code-block:: python

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

.. contents::

.. section-numbering::

Installation
============

Install ``ezenum`` with:

.. code-block:: bash

  pip install ezenum


Features
========

* Pure Python.
* Compatible with Python 3.5+.
* Easy creation of usefull enum objects.
* String enums with unified value and name attributes.


Use
===

StringEnum
----------

Easilly get a string enum from a string list.



Contributing
============

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


Installing for development
--------------------------

Clone:

.. code-block:: bash

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


Install in development mode with test dependencies:

.. code-block:: bash

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


Running the tests
-----------------

To run the tests, use:

.. code-block:: bash

  python -m pytest --cov=ezenum


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`_.

.. _`numpy docstring conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
.. _`these conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt


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


.. |PyPI-Status| image:: https://img.shields.io/pypi/v/ezenum.svg
  :target: https://pypi.python.org/pypi/ezenum

.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/ezenum.svg
   :target: https://pypi.python.org/pypi/ezenum

.. |Build-Status| image:: https://travis-ci.org/shaypal5/ezenum.svg?branch=master
  :target: https://travis-ci.org/shaypal5/ezenum

.. |LICENCE| image:: https://img.shields.io/pypi/l/ezenum.svg
  :target: https://pypi.python.org/pypi/ezenum

.. |Codecov| image:: https://codecov.io/github/shaypal5/ezenum/coverage.svg?branch=master
   :target: https://codecov.io/github/shaypal5/ezenum?branch=master

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "enum", 
    "upload_time": "2018-03-13 16:19:02", 
    "author": "Shay Palachy", 
    "home_page": "https://github.com/shaypal5/ezenum", 
    "github_user": "shaypal5", 
    "download_url": "https://pypi.python.org/packages/b3/eb/2dcf972c77f0d7b0226ff68daa736ebdf39031e004fdc9e3c7f67a3e0dd0/valve-0.0.0.tar.gz", 
    "platform": "any", 
    "version": "0.0.0", 
    "cheesecake_documentation_id": null, 
    "description": "ezenum\n######\n|PyPI-Status| |PyPI-Versions| |Build-Status| |Codecov| |LICENCE|\n\nEasy enums for Python.\n\n.. code-block:: python\n\n  >>> RGB = StringEnum(['Red', 'Green', 'Blue'])\n  >>> RGB.Red\n      'Red'\n\n.. contents::\n\n.. section-numbering::\n\nInstallation\n============\n\nInstall ``ezenum`` with:\n\n.. code-block:: bash\n\n  pip install ezenum\n\n\nFeatures\n========\n\n* Pure Python.\n* Compatible with Python 3.5+.\n* Easy creation of usefull enum objects.\n* String enums with unified value and name attributes.\n\n\nUse\n===\n\nStringEnum\n----------\n\nEasilly get a string enum from a string list.\n\n\n\nContributing\n============\n\nPackage author and current maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help.\n\n\nInstalling for development\n--------------------------\n\nClone:\n\n.. code-block:: bash\n\n  git clone git@github.com:shaypal5/ezenum.git\n\n\nInstall in development mode with test dependencies:\n\n.. code-block:: bash\n\n  cd ezenum\n  pip install -e \".[test]\"\n\n\nRunning the tests\n-----------------\n\nTo run the tests, use:\n\n.. code-block:: bash\n\n  python -m pytest --cov=ezenum\n\n\nAdding documentation\n--------------------\n\nThis 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`_.\n\n.. _`numpy docstring conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt\n.. _`these conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt\n\n\nCredits\n=======\nCreated by Shay Palachy (shay.palachy@gmail.com).\n\n\n.. |PyPI-Status| image:: https://img.shields.io/pypi/v/ezenum.svg\n  :target: https://pypi.python.org/pypi/ezenum\n\n.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/ezenum.svg\n   :target: https://pypi.python.org/pypi/ezenum\n\n.. |Build-Status| image:: https://travis-ci.org/shaypal5/ezenum.svg?branch=master\n  :target: https://travis-ci.org/shaypal5/ezenum\n\n.. |LICENCE| image:: https://img.shields.io/pypi/l/ezenum.svg\n  :target: https://pypi.python.org/pypi/ezenum\n\n.. |Codecov| image:: https://codecov.io/github/shaypal5/ezenum/coverage.svg?branch=master\n   :target: https://codecov.io/github/shaypal5/ezenum?branch=master\n", 
    "lcname": "valve", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": true, 
    "name": "valve", 
    "license": "MIT", 
    "travis_ci": false, 
    "github_project": "ezenum", 
    "summary": "Great package.", 
    "split_keywords": [
        "enum"
    ], 
    "author_email": "shaypal5@gmail.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2018-03-13T16:19:04", 
            "comment_text": "", 
            "python_version": "3.6", 
            "url": "https://pypi.python.org/packages/08/96/cb4e29786c158988c7404bea48683449ce745b053e41143c015ba8e11af3/valve-0.0.0-py2.py3-none-any.whl", 
            "md5_digest": "a15166b66014fe2879894d2b715d88b2", 
            "downloads": 0, 
            "filename": "valve-0.0.0-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "08/96/cb4e29786c158988c7404bea48683449ce745b053e41143c015ba8e11af3/valve-0.0.0-py2.py3-none-any.whl", 
            "size": 10451
        }, 
        {
            "has_sig": false, 
            "upload_time": "2018-03-13T16:19:02", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/b3/eb/2dcf972c77f0d7b0226ff68daa736ebdf39031e004fdc9e3c7f67a3e0dd0/valve-0.0.0.tar.gz", 
            "md5_digest": "63c35d6c239522e404d8f54e5a1b17c7", 
            "downloads": 0, 
            "filename": "valve-0.0.0.tar.gz", 
            "packagetype": "sdist", 
            "path": "b3/eb/2dcf972c77f0d7b0226ff68daa736ebdf39031e004fdc9e3c7f67a3e0dd0/valve-0.0.0.tar.gz", 
            "size": 19249
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}