KevinMidboe/tableprint
1
0
Fork 0
mirror of https://github.com/KevinMidboe/tableprint.git synced 2025-10-29 09:50:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

added installation and usage sections to README

Browse Source
This commit is contained in:
Niru Maheswaranathan
2015-02-24 13:10:37 -08:00
parent 6a7ef77f24
commit 0dc1d4fb77
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -7,8 +7,21 @@ Unlike other modules, you can print single rows of data at a time (useful for pr
Also, `tableprint` is fast (minimal processing required) and is therefore relevant for printing updates during speed-intensive computations.
## Installation
```bash
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:
```python
import tableprint
import numpy as np
data = np.random.randn(10,3)
headers = ['Column A', 'Column B', 'Column C']
tableprint.table(data, headers)
```
## License
MIT Licensed. See `License.md`