Merge branch 'main' into gt_plt_summary_customization

Author: juleswg23

.gitignore

@@ -124,3 +124,5 @@ sandbox.*
 possible_feats.*
 compare_themes.py
 compare_tables.html
+
+README_FILES/

README.md

@@ -2,7 +2,7 @@
 
 [![Python Versions](https://img.shields.io/pypi/pyversions/gt_extras.svg)](https://pypi.python.org/pypi/gt-extras)
 [![PyPI](https://img.shields.io/pypi/v/gt-extras?logo=python&logoColor=white&color=orange)](https://pypi.org/project/gt-extras/)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/gt-extras)](https://pypistats.org/packages/gt-extras)
+[![PyPI Downloads](https://static.pepy.tech/badge/gt-extras)](https://pepy.tech/projects/gt-extras)
 [![License](https://img.shields.io/github/license/posit-dev/gt-extras)](https://github.com/posit-dev/gt-extras/blob/main/LICENSE)
 
 [![Tests](https://github.com/posit-dev/gt-extras/actions/workflows/ci_tests.yml/badge.svg)](https://github.com/posit-dev/gt-extras/actions/workflows/ci_tests.yml)

docs/_quarto.yml

@@ -51,6 +51,7 @@ quartodoc:
         - gt_plt_bar_stack
         - gt_plt_bullet
         - gt_plt_conf_int
+        - gt_plt_donut
         - gt_plt_dot
         - gt_plt_dumbbell
         - gt_plt_summary
@@ -92,6 +93,7 @@ quartodoc:
         - fa_icon_repeat
         - gt_fa_rank_change
         - gt_fa_rating
+        - gt_fmt_img_circle
         - img_header
 
     - title: Utilities

docs/examples/index.qmd

@@ -183,6 +183,11 @@ addEventListener('resize', setTableWidths);
 [gt_plt_conf_int](./with-code.html#gt_plt_conf_int){.embed-hover-overlay}
 :::
 
+:::{.masonry-item style="--width: 623;"}
+{{< embed with-code.qmd#gt_plt_donut >}}
+[gt_plt_donut](./with-code.html#gt_plt_donut){.embed-hover-overlay}
+:::
+
 :::{.masonry-item style="--width: 304;"}
 {{< embed with-code.qmd#gt_plt_dot >}}
 [gt_plt_dot](./with-code.html#gt_plt_dot){.embed-hover-overlay}
@@ -288,6 +293,11 @@ addEventListener('resize', setTableWidths);
 [gt_fa_rating](./with-code.html#gt_fa_rating){.embed-hover-overlay}
 :::
 
+:::{.masonry-item style="--width: 304;"}
+{{< embed with-code.qmd#gt_fmt_img_circle >}}
+[gt_fmt_img_circle](./with-code.html#gt_fmt_img_circle){.embed-hover-overlay}
+:::
+
 :::{.masonry-item style="--width: 355;"}
 {{< embed with-code.qmd#img_header >}}
 [img_header](./with-code.html#img_header){.embed-hover-overlay}

docs/examples/with-code.qmd

@@ -472,6 +472,35 @@ gt.pipe(
 ```
 {{< include ./_show-last.qmd >}}
 
+### [gt_plt_donut](https://posit-dev.github.io/gt-extras/reference/gt_plt_donut.html){title="Click for reference"}
+```{python}
+# | label: gt_plt_donut
+from great_tables import GT
+from great_tables.data import gtcars
+import gt_extras as gte
+
+gtcars_mini = gtcars.loc[
+    9:17,
+    ["model", "mfr", "year", "hp", "hp_rpm", "trq", "trq_rpm", "mpg_c", "mpg_h"]
+]
+
+gt = (
+    GT(gtcars_mini, rowname_col="model")
+    .tab_stubhead(label="Car")
+    .cols_align("center")
+    .cols_align("left", columns="mfr")
+)
+
+gt.pipe(
+    gte.gt_plt_donut,
+    columns=["hp", "hp_rpm", "trq", "trq_rpm", "mpg_c", "mpg_h"],
+    size=40,
+    fill="steelblue"
+)
+```
+{{< include ./_show-last.qmd >}}
+
+
 ### [gt_plt_dot](https://posit-dev.github.io/gt-extras/reference/gt_plt_dot.html){title="Click for reference"}
 ```{python}
 # | label: gt_plt_dot
@@ -949,6 +978,29 @@ gt.pipe(gte.gt_fa_rating, columns="rating", name="star")
 ```
 {{< include ./_show-last.qmd >}}
 
+### [gt_fmt_img_circle](https://posit-dev.github.io/gt-extras/reference/gt_fmt_img_circle.html){title="Click for reference"}
+```{python}
+# | label: gt_fmt_img_circle
+import polars as pl
+from great_tables import GT
+import gt_extras as gte
+
+rich_avatar = "https://avatars.githubusercontent.com/u/5612024?v=4"
+michael_avatar = "https://avatars.githubusercontent.com/u/2574498?v=4"
+jules_avatar = "https://avatars.githubusercontent.com/u/54960783?v=4"
+
+
+df = pl.DataFrame({"@machow": [michael_avatar], "@rich-iannone": [rich_avatar], "@juleswg23": [jules_avatar]})
+
+(
+    GT(df)
+    .cols_align("center")
+    .opt_stylize(color="green", style=6)
+    .pipe(gte.gt_fmt_img_circle, height=80)
+)
+```
+{{< include ./_show-last.qmd >}}
+
 ### [img_header](https://posit-dev.github.io/gt-extras/reference/img_header.html){title="Click for reference"}
 ```{python}
 # | label: img_header

gt_extras/__init__.py

@@ -9,13 +9,14 @@
 from .formatting import fmt_pct_extra, gt_duplicate_column, gt_two_column_layout
 from .html import gt_merge_stack, with_hyperlink, with_tooltip
 from .icons import fa_icon_repeat, gt_fa_rank_change, gt_fa_rating
-from .images import add_text_img, img_header
+from .images import add_text_img, gt_fmt_img_circle, img_header
 from .plotting import (
     gt_plt_bar,
     gt_plt_bar_pct,
     gt_plt_bar_stack,
     gt_plt_bullet,
     gt_plt_conf_int,
+    gt_plt_donut,
     gt_plt_dot,
     gt_plt_dumbbell,
     gt_plt_winloss,
@@ -56,6 +57,7 @@
     "gt_plt_dot",
     "gt_plt_conf_int",
     "gt_plt_dumbbell",
+    "gt_plt_donut",
     "gt_plt_winloss",
     "gt_plt_bar_stack",
     "with_hyperlink",
@@ -66,6 +68,7 @@
     "gt_two_column_layout",
     "add_text_img",
     "img_header",
+    "gt_fmt_img_circle",
     "gt_add_divider",
     "gt_plt_summary",
 ]