added frame() helper function to print a pandas DataFrame

This commit is contained in:
Niru Maheswaranathan
2015-02-26 12:29:55 -08:00
parent c6f5dbe4f3
commit 477f71a6ec
2 changed files with 30 additions and 3 deletions

View File

@@ -14,7 +14,7 @@ setup(
# Versions should comply with PEP440. For a discussion on single-sourcing
# the version across setup.py and the project code, see
# https://packaging.python.org/en/latest/single_source_version.html
version='0.1.0',
version='0.1.1',
description='Pretty ASCII printing of tabular data',
long_description=long_description,
@@ -65,7 +65,7 @@ setup(
# project is installed. For an analysis of "install_requires" vs pip's
# requirements files see:
# https://packaging.python.org/en/latest/requirements.html
install_requires=[],
install_requires=['pandas'],
# List additional groups of dependencies here (e.g. development dependencies).
# You can install these using the following syntax, for example:

View File

@@ -3,8 +3,35 @@ Module to nicely format ASCII table rows for display
"""
# imports
import numpy as np
# exports
__all__ = ['table', 'row', 'header']
__all__ = ['table', 'row', 'header', 'frame']
def frame(df, options=None):
"""
Print an ASCII table using the given pandas DataFrame
Parameters
----------
df : DataFrame
A pandas DataFrame with consisting of the table to print
options : dict
A dictionary of options. Defaults:
{
'column_width' : 10, # the width of each column in the table
'outer_char' : '|', # the character defining the outer border of the table
'corner_char' : '+', # printed at the junctions of the table lines
'line_char' : '-', # character as part of each horizontal rule
'precision' : '2f' # precision string for formatting numbers
}
"""
table(np.array(df), list(df.columns), options)
def table(data, headers, options=None):