From 016e47b04882e27375437c10b355f63d72d7131f Mon Sep 17 00:00:00 2001 From: Richard Iannone Date: Tue, 3 Dec 2024 14:07:28 -0500 Subject: [PATCH 1/2] Add conda install instructions --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b25564884..7791e51f8 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,12 @@ The **Great Tables** package can be installed from **PyPI** with: $ pip install great_tables ``` +You can also install [Great Tables from Conda-Forge](https://anaconda.org/conda-forge/great_tables) by using: + +```bash +conda install conda-forge::great_tables +``` + 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](https://github.com/posit-dev/great-tables/issues). ## Code of Conduct From 5b320f8ca3a8c00ef6640c76ac8fb4f9b6c6d5cb Mon Sep 17 00:00:00 2001 From: Richard Iannone Date: Tue, 3 Dec 2024 14:16:46 -0500 Subject: [PATCH 2/2] Improve description of GT outputs and where to use --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7791e51f8..df5230d0b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ With **Great Tables** anyone can make wonderful-looking tables in Python. The ph -It all begins with **table data** in the form of a Pandas or Polars DataFrame. You then decide how to compose your output table with the elements and formatting you need for the task at hand. Finally, the table is rendered by printing it at the console, including it in an notebook environment, or rendering it inside a **Quarto** document. +It all begins with **table data** in the form of a Pandas or Polars DataFrame. You then decide how to compose your output table with the elements and formatting you need for the task at hand. Finally, the table is rendered to HTML (the default option) or to an image file. The **Great Tables** package is designed to be both straightforward yet powerful. The emphasis is on simple methods for the everyday display table needs (but power when you need it). Here is a brief example of how to use **Great Tables** to create a table from the included `sp500` dataset: @@ -56,6 +56,8 @@ sp500_mini = sp500[(sp500["date"] >= start_date) & (sp500["date"] <= end_date)] +Typically we use Great Tables in an notebook environment or within a [**Quarto**](https://quarto.org) document. Tables won't print to the console, but using the [`show()` method](https://posit-dev.github.io/great-tables/reference/GT.show.html#great_tables.GT.show) on a table object while in the console will open the HTML table in your default browser. + There are ten datasets provided by **Great Tables**: `countrypops`, `sza`, `gtcars`, `sp500`, `pizzaplace`, `exibble`, `towny`, `metro`, `constants`, and `illness`.