Skip to main content

A framework for CLI/shell programs.

Project description

shellish
========

***Command-line/shell mashup framework***

|PyPI| |PyPI| |Change Log| |Build Status| |PyPI|

--------------

This module combines the Python standard library modules argparse and
cmd to provide a unified way to make cli programs that can also be
interactive (when invoked in "shell" mode).

The main benefit to using this package is streamlined command hierarchy
when you want to have rich set of subcommands along with a pretty
powerful tab completion layer that parses argparse arguments
automagically.

Requirements
------------

Posix-like platform

Installation
------------

**PyPi Stable Release**

::

pip3 install shellish

**Development Release**

::

python3.4 ./setup.py build
python3.4 ./setup.py install

*or*

::

python3.4 ./setup.py develop

Compatibility
-------------

- Python 3.4+

Examples
--------

- `Hello World <examples/hello_world.py>`__
- `Decorator <examples/decorator.py>`__
- `Nesting (Subcommands) <examples/simple_nesting.py>`__
- `Alternate Styles <examples/skin_a_cat.py>`__
- `Tab Completion <examples/tabcompletion.py>`__

--------------

`All Examples <examples/>`__

.. |PyPI| image:: https://img.shields.io/pypi/status/shellish.svg
:target: https://pypi.python.org/pypi/shellish
.. |PyPI| image:: https://img.shields.io/pypi/l/shellish.svg
:target: https://pypi.python.org/pypi/shellish
.. |Change Log| image:: https://img.shields.io/badge/change-log-blue.svg
:target: https://github.com/mayfield/shellish/blob/master/CHANGELOG.md
.. |Build Status| image:: https://semaphoreci.com/api/v1/projects/d925ee35-bede-4cc1-bbb8-17a738b84cfa/533600/shields_badge.svg
:target: https://semaphoreci.com/mayfield/shellish
.. |PyPI| image:: https://img.shields.io/pypi/dm/shellish.svg
:target: https://pypi.python.org/pypi/shellish

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shellish-0.5.6.tar.gz (23.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page