termpandas

Scrollable Pandas and Polars DataFrames in the Terminal.

Installation

pip install termpandas

Note: This library is not compatible with Windows at the moment.

Basic Usage

import pandas as pd
from termpandas import tprint

df = pd.read_csv('titanic.csv')
tprint(df)

• Key Bindings:
  • k or Up Arrow Key to scroll up
  • j or Down Arrow Key to scroll down
  • h or Left Arrow Key to scroll left
  • l or Right Arrow Key to scroll right
  • enter to select a row
  • q to quit

Parameters

• num_rows: Number of rows to display at a time. Default is 10.

tprint(df, num_rows=5)

• highlight: Highlights the selected row. Default is True.

tprint(df, highlight=True)

• highlight_color: Color of the selected row. Default is Gray.

tprint(df, highlight_color='Gray')

• masks: Dictionary of masks to highlight rows. Default is {}. The keys are the colors and the values are the masks.

mask_1 = df['Survived'] == 1
mask_2 = df['Sex'] == 'male'
tprint(df.head(20), masks={'Red': mask_1,'Blue': mask_2})

• return_row: Returns the selected row. Default is False. Press enter to select a row.

result = tprint(df.head(20), return_row=True)
try:
    tprint(result)
except:
    print("Quit termpandas: No row selected")

Polars Support

• Note: Masks are not currently supported for Polars DataFrames. Convert to pandas DataFrames to utilize masks functionality.

• Returning Selected Row is supported and works just like with Pandas DataFrames.

import polars as pl
from termpandas import tprint

# DataFrame needs to be collected
df = pl.scan_csv('titanic.csv').collect()
tprint(df)

Available Colors

• Red
• Blue
• Magenta
• Gray