gt-extras

⚠️ gt-extras is currently in development, expect breaking changes.

What is gt-extras?

A collection of additional helper functions for creating beautiful tables with the great-tables package in Python.

The functions in gt-extras are designed to make it easier to add plots, icons, color gradients, and other enhancements to your tables. We wrap up common patterns and boilerplate so you can focus on your data and presentation. It is based on the R package gtExtras, which was designed with a similar goal in mind.

Installation

Install the latest release from PyPI: pip install gt-extras

Example Usage

from great_tables import GT
from great_tables.data import gtcars
import gt_extras as gte

gtcars_mini = gtcars.iloc[5:15].copy().reset_index(drop=True)
gtcars_mini["efficiency"] = gtcars_mini["mpg_c"] / gtcars_mini["hp"] * 100

(
    # Start with a standard GT
    GT(gtcars_mini, rowname_col="model")
    .tab_stubhead(label="Vehicle")
    .cols_hide(["drivetrain", "hp_rpm", "trq_rpm", "trim", "bdy_style", "msrp", "trsmn", "ctry_origin"])
    .cols_align("center")
    .tab_header(title="Car Performance Review", subtitle="Using gt-extras functionality")

    # Add gt-extras features using gt.pipe()
    .pipe(gte.gt_color_box, columns=["hp", "trq"], palette=["lightblue", "darkblue"])
    .pipe(gte.gt_plt_dot, category_col="mfr", data_col="efficiency", domain=[0, 0])
    .pipe(gte.gt_plt_bar, columns=["mpg_c", "mpg_h"])
    .pipe(gte.gt_fa_rating, columns="efficiency")
    .pipe(gte.gt_hulk_col_numeric, columns="year", palette="viridis")
    .pipe(gte.gt_theme_538)
)

Features

• Apply color gradients and highlights
• Add plots to table cells for visual data representation
• Embed FontAwesome icons
• Use pre-built themes for quick styling
• Utilize helper utilities for common table tasks

Contributing

If you encounter a bug, have usage questions, or want to share ideas to make this package better, please feel free to file an issue.

In general, if you're interested in extending Great Tables functionality, this subsection of the Great Tables get-started page is a great place to start.

Some of the work that went into this project was featured on the great tables blog, if you choose to contribute hopefully that can give you a sense of the process!

Code of Conduct

Please note that the gt-extras project is released with a contributor code of conduct.
By participating in this project you agree to abide by its terms.

📄 License

Great Tables is licensed under the MIT license.

© Posit Software, PBC.

Citation

If you use gt-extras in your work, please cite the package:

@software{gt_extras,
authors = {Jules Walzer-Goldfeld, Michael Chow, and Rich Iannone},
license = {MIT},
title = {{gt-extras: Extra helpers for great-tables in Python.}},
url = {https://github.com/posit-dev/gt-extras}, version = {0.0.1}
}

For more information, see the docs or open an issue with questions or suggestions!