summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 49366478b7f6e859b1cbcdec17627f45ae7db020 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
===========
CLI Helpers
===========

.. image:: https://travis-ci.org/dbcli/cli_helpers.svg?branch=master
    :target: https://travis-ci.org/dbcli/cli_helpers

.. image:: https://ci.appveyor.com/api/projects/status/37a1ri2nbcp237tr/branch/master?svg=true
    :target: https://ci.appveyor.com/project/dbcli/cli-helpers

.. image:: https://codecov.io/gh/dbcli/cli_helpers/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/dbcli/cli_helpers

.. image:: https://img.shields.io/pypi/v/cli_helpers.svg?style=flat
    :target: https://pypi.python.org/pypi/cli_helpers

.. start-body

CLI Helpers is a Python package that makes it easy to perform common tasks when
building command-line apps. It's a helper library for command-line interfaces.

Libraries like `Click <http://click.pocoo.org/5/>`_ and
`Python Prompt Toolkit <https://python-prompt-toolkit.readthedocs.io/en/latest/>`_
are amazing tools that help you create quality apps. CLI Helpers complements
these libraries by wrapping up common tasks in simple interfaces.

CLI Helpers is not focused on your app's design pattern or framework -- you can
use it on its own or in combination with other libraries. It's lightweight and
easy to extend.

What's included in CLI Helpers?

- Prettyprinting of tabular data with custom pre-processing
- Config file reading/writing

.. end-body

Read the documentation at http://cli-helpers.rtfd.io