Metadata-Version: 2.0
Name: climenu
Version: 1.6.0
Summary: Command-line menu system
Home-page: https://github.com/mtik00/pyclimenu
Author: Timothy McFadden
Author-email: tim@timandjamie.com
License: MIT
Download-URL: https://github.com/mtik00/pyclimenu/releases/download/v1.6.0/climenu-1.6.0.tar.gz
Keywords: cli command-line menu
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 5 - Production/Stable

.. image:: https://travis-ci.org/mtik00/pyclimenu.svg?branch=master
    :target: https://travis-ci.org/mtik00/pyclimenu

.. image:: https://coveralls.io/repos/github/mtik00/pyclimenu/badge.svg?branch=master
    :target: https://coveralls.io/github/mtik00/pyclimenu?branch=master

.. image:: https://img.shields.io/pypi/v/climenu.svg
    :target: https://pypi.python.org/pypi/climenu

climenu
=======
This project is used to create *simple* command-line interfaces using
text-based menus.

The interface loosely mimics `click <http://click.pocoo.org>`_ (the use of
decorators to define the interface).

Documentation is hosted `on ReadTheDocs <http://pyclimenu.rtfd.io/>`_; releases
are hosted `on pypi <https://pypi.python.org/pypi/climenu>`_.

----

Example:

.. code-block:: python

    from __future__ import print_function
    import climenu

    @climenu.menu()
    def build_release():
        '''Build release'''
        print("built the release")

    @climenu.menu()
    def build_package():
        '''Build the package'''
        print("built the package")

    if __name__ == '__main__':
        climenu.run()


