From e05cf955fce39cd3dda8a4d553b1425924146fed Mon Sep 17 00:00:00 2001 From: Niru Maheswaranathan Date: Mon, 28 Sep 2015 14:40:31 -0700 Subject: [PATCH] Adds docs --- .gitignore | 3 ++- docs/index.html | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 docs/index.html diff --git a/.gitignore b/.gitignore index 04f83a8..486036c 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ lib/ lib64/ *.egg-info/ *.egg +*.zip # PyCharm -.idea/ \ No newline at end of file +.idea/ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..8f26898 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,33 @@ +

tableprint

+

Pretty ASCII printing of tabular data in python

+Fork me on GitHub +

PyPi version

+
+

Example output

+Example output +
+

About

+

tableprint lets you easily print pretty ASCII formatted tables of data. Unlike other modules, you can print single rows of data at a time (useful for printing ongoing computation results). Also, tableprint is fast (minimal processing required) and is therefore relevant for printing updates during speed-intensive computations.

+

Installation

+
pip install tableprint
+

Usage

+

The tableprint.table function takes in a matrix of data, a list of headers, and an optional dictionary of parameters. To print a dataset consisting of 10 rows of 3 different columns:

+
import tableprint
+import numpy as np
+
+data = np.random.randn(10,3)
+headers = ['Column A', 'Column B', 'Column C']
+
+tableprint.table(data, headers)
+

The header and row functions allow you to print just the header or just a row of data, respectively, which is useful for continuously updating a table during a long-running computation.

+

Dependencies

+ +

Version

+ +

License

+

MIT