.. FriendlyShell documentation master file, created by
   sphinx-quickstart on Thu Apr 19 21:33:23 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to FriendlyShell's documentation!
=========================================

.. image:: https://img.shields.io/pypi/l/friendlyshell.svg
    :target: https://github.com/TheFriendlyCoder/friendlyshell/blob/master/LICENSE
    :alt: License

.. image:: https://coveralls.io/repos/github/TheFriendlyCoder/friendlyshell/badge.svg?branch=master
     :target: https://coveralls.io/github/TheFriendlyCoder/friendlyshell?branch=master
     :alt: Test Coverage

.. image:: https://readthedocs.org/projects/friendlyshell/badge/?version=latest
    :target: http://friendlyshell.readthedocs.io/en/latest
    :alt: Documentation Status

.. image:: https://requires.io/github/TheFriendlyCoder/friendlyshell/requirements.svg?branch=master
     :target: https://requires.io/github/TheFriendlyCoder/friendlyshell/requirements/?branch=master
     :alt: Requirements Status

.. image:: https://img.shields.io/pypi/pyversions/friendlyshell.svg
    :target: https://pypi.org/project/friendlyshell/
    :alt: Python Versions

.. image:: https://img.shields.io/pypi/format/friendlyshell.svg
    :target: https://pypi.org/project/friendlyshell/
    :alt: Format

.. image:: https://badge.fury.io/py/friendlyshell.svg
    :target: https://pypi.org/project/friendlyshell/
    :alt: Latest Version

.. image:: https://api.travis-ci.org/TheFriendlyCoder/friendlyshell.svg?branch=master
    :target: https://travis-ci.org/TheFriendlyCoder/friendlyshell
    :alt: Build status


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

=============
Overview
=============

Framework for writing interactive Python command line interfaces, similar to
the 'cmd' built in class.






Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`