itables 2.1.4__tar.gz → 2.2.0__tar.gz

{itables-2.1.4 → itables-2.2.0}/.github/workflows/continuous-integration.yml

@@ -87,6 +87,10 @@ jobs:
         if: matrix.polars
         run: pip install -e .[polars]
 
+      - name: Install shiny
+        if: matrix.python-version != '3.7'
+        run: pip install "shiny>=1.0"
+
       - name: Uninstall jinja2
         if: matrix.uninstall_jinja2
         run: pip uninstall jinja2 -y

{itables-2.1.4 → itables-2.2.0}/.github/workflows/publish-book.yml

@@ -30,6 +30,7 @@ jobs:
         pip install jupyter-book
         pip install matplotlib  # Pandas style
         pip install .[polars]
+        pip install .[widget]
 
     - name: Create a kernel
       run: |

{itables-2.1.4 → itables-2.2.0}/.gitignore

@@ -30,3 +30,6 @@ dt_bundle.css
 
 # Streamlit package
 src/itables/itables_for_streamlit
+
+# Jupyter Widget
+src/itables/widget/static

{itables-2.1.4 → itables-2.2.0}/.pre-commit-config.yaml

@@ -32,7 +32,7 @@ repos:
     rev: v1.16.2
     hooks:
     - id: jupytext
-      exclude: dt_for_itables/
+      exclude: packages/
       types: ["markdown"]
       args: ["--pipe", "isort {} --treat-comment-as-code '# %%' --profile black", "--pipe", "black", "--check", "ruff check {} --ignore E402"]
       additional_dependencies:

{itables-2.1.4 → itables-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: itables
-Version: 2.1.4
+Version: 2.2.0
 Summary: Pandas and Polar DataFrames as interactive DataTables
 Project-URL: Homepage, https://mwouts.github.io/itables/
 Project-URL: Documentation, https://mwouts.github.io/itables
@@ -50,11 +50,30 @@ Requires-Dist: ipython
 Requires-Dist: numpy
 Requires-Dist: pandas
 Provides-Extra: all
+Requires-Dist: anywidget; extra == 'all'
 Requires-Dist: matplotlib; extra == 'all'
 Requires-Dist: polars; extra == 'all'
 Requires-Dist: pyarrow; extra == 'all'
 Requires-Dist: pytz; extra == 'all'
+Requires-Dist: traitlets; extra == 'all'
 Requires-Dist: world-bank-data; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: anywidget; extra == 'dev'
+Requires-Dist: ipykernel; extra == 'dev'
+Requires-Dist: jupyterlab; extra == 'dev'
+Requires-Dist: jupytext; extra == 'dev'
+Requires-Dist: matplotlib; extra == 'dev'
+Requires-Dist: nbconvert; extra == 'dev'
+Requires-Dist: polars; extra == 'dev'
+Requires-Dist: pyarrow; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytz; extra == 'dev'
+Requires-Dist: requests; extra == 'dev'
+Requires-Dist: shiny; extra == 'dev'
+Requires-Dist: traitlets; extra == 'dev'
+Requires-Dist: watchfiles; extra == 'dev'
+Requires-Dist: world-bank-data; extra == 'dev'
 Provides-Extra: polars
 Requires-Dist: polars; extra == 'polars'
 Requires-Dist: pyarrow; extra == 'polars'
@@ -64,6 +83,7 @@ Requires-Dist: world-bank-data; extra == 'samples'
 Provides-Extra: style
 Requires-Dist: matplotlib; extra == 'style'
 Provides-Extra: test
+Requires-Dist: anywidget; extra == 'test'
 Requires-Dist: ipykernel; extra == 'test'
 Requires-Dist: jupytext; extra == 'test'
 Requires-Dist: matplotlib; extra == 'test'
@@ -75,17 +95,22 @@ Requires-Dist: pytest-cov; extra == 'test'
 Requires-Dist: pytz; extra == 'test'
 Requires-Dist: requests; extra == 'test'
 Requires-Dist: shiny; extra == 'test'
+Requires-Dist: traitlets; extra == 'test'
 Requires-Dist: world-bank-data; extra == 'test'
+Provides-Extra: widget
+Requires-Dist: anywidget; extra == 'widget'
+Requires-Dist: traitlets; extra == 'widget'
 Description-Content-Type: text/markdown
 
 ![ITables logo](https://raw.githubusercontent.com/mwouts/itables/3f8e8bd75af7ad38a500518fcb4fbbc370ea6c4c/itables/logo/wide.svg)
 
-![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main)
+[![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main)](https://github.com/mwouts/itables/actions)
 [![codecov.io](https://codecov.io/github/mwouts/itables/coverage.svg?branch=main)](https://codecov.io/github/mwouts/itables?branch=main)
 [![Pypi](https://img.shields.io/pypi/v/itables.svg)](https://pypi.python.org/pypi/itables)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/itables.svg)](https://anaconda.org/conda-forge/itables)
 [![pyversions](https://img.shields.io/pypi/pyversions/itables.svg)](https://pypi.python.org/pypi/itables)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Jupyter Widget](https://img.shields.io/badge/Jupyter-Widget-F37626.svg?style=flat&logo=Jupyter)](https://mwouts.github.io/itables/ipywidgets.html)
 [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_red.svg)](https://itables.streamlit.app)
 
 This packages changes how Pandas and Polars DataFrames are rendered in Jupyter Notebooks.
@@ -128,7 +153,7 @@ and then render any DataFrame as an interactive table that you can sort, search
 If you prefer to render only selected DataFrames as interactive tables, use `itables.show` to show just one Series or DataFrame as an interactive table:
 ![show](docs/show_df.png)
 
-Since `itables==1.0.0`, the [jQuery](https://jquery.com/) and [DataTables](https://datatables.net/) libraries and CSS
+Since ITables v1.0, the [jQuery](https://jquery.com/) and [DataTables](https://datatables.net/) libraries and CSS
 are injected in the notebook when you execute `init_notebook_mode` with its default argument `connected=False`.
 Thanks to this the interactive tables will work even without a connection to the internet.
 
@@ -143,6 +168,7 @@ You can also use ITables in [Quarto](https://mwouts.github.io/itables/quarto.htm
 
 ITables works well in VS Code, both in Jupyter Notebooks and in interactive Python sessions.
 
-Last but not least, ITables is also available in
-[Streamlit](https://mwouts.github.io/itables/streamlit.html) or
-[Shiny](https://mwouts.github.io/itables/shiny.html) applications.
+Last but not least, ITables is also available as
+- a [Jupyter Widget](https://mwouts.github.io/itables/ipywidgets.html)
+- a [Streamlit](https://mwouts.github.io/itables/streamlit.html) component,
+- and it also works in [Shiny](https://mwouts.github.io/itables/shiny.html) applications.

{itables-2.1.4 → itables-2.2.0}/README.md

@@ -1,11 +1,12 @@
 ![ITables logo](https://raw.githubusercontent.com/mwouts/itables/3f8e8bd75af7ad38a500518fcb4fbbc370ea6c4c/itables/logo/wide.svg)
 
-![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main)
+[![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main)](https://github.com/mwouts/itables/actions)
 [![codecov.io](https://codecov.io/github/mwouts/itables/coverage.svg?branch=main)](https://codecov.io/github/mwouts/itables?branch=main)
 [![Pypi](https://img.shields.io/pypi/v/itables.svg)](https://pypi.python.org/pypi/itables)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/itables.svg)](https://anaconda.org/conda-forge/itables)
 [![pyversions](https://img.shields.io/pypi/pyversions/itables.svg)](https://pypi.python.org/pypi/itables)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Jupyter Widget](https://img.shields.io/badge/Jupyter-Widget-F37626.svg?style=flat&logo=Jupyter)](https://mwouts.github.io/itables/ipywidgets.html)
 [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_red.svg)](https://itables.streamlit.app)
 
 This packages changes how Pandas and Polars DataFrames are rendered in Jupyter Notebooks.
@@ -48,7 +49,7 @@ and then render any DataFrame as an interactive table that you can sort, search
 If you prefer to render only selected DataFrames as interactive tables, use `itables.show` to show just one Series or DataFrame as an interactive table:
 ![show](docs/show_df.png)
 
-Since `itables==1.0.0`, the [jQuery](https://jquery.com/) and [DataTables](https://datatables.net/) libraries and CSS
+Since ITables v1.0, the [jQuery](https://jquery.com/) and [DataTables](https://datatables.net/) libraries and CSS
 are injected in the notebook when you execute `init_notebook_mode` with its default argument `connected=False`.
 Thanks to this the interactive tables will work even without a connection to the internet.
 
@@ -63,6 +64,7 @@ You can also use ITables in [Quarto](https://mwouts.github.io/itables/quarto.htm
 
 ITables works well in VS Code, both in Jupyter Notebooks and in interactive Python sessions.
 
-Last but not least, ITables is also available in
-[Streamlit](https://mwouts.github.io/itables/streamlit.html) or
-[Shiny](https://mwouts.github.io/itables/shiny.html) applications.
+Last but not least, ITables is also available as
+- a [Jupyter Widget](https://mwouts.github.io/itables/ipywidgets.html)
+- a [Streamlit](https://mwouts.github.io/itables/streamlit.html) component,
+- and it also works in [Shiny](https://mwouts.github.io/itables/shiny.html) applications.

{itables-2.1.4 → itables-2.2.0}/docs/_toc.yml

@@ -4,22 +4,24 @@ parts:
   - caption: ITables in Notebooks
     chapters:
     - file: advanced_parameters
+    - file: select
+    - file: extensions
+    - file: custom_extensions
     - file: custom_css
     - file: formatting
     - file: pandas_style
-    - file: extensions
-    - file: custom_extensions
+    - file: dark_mode
     - file: quarto
     - file: downsampling
     - file: references
     - file: supported_editors
   - caption: ITables in Applications
     chapters:
-      - file: html_export
-      - file: dash
-      - file: shiny
-      - file: streamlit
       - file: ipywidgets
+      - file: streamlit
+      - file: shiny
+      - file: dash
+      - file: html_export
   - caption: Contributing to ITables
     chapters:
       - file: contributing

{itables-2.1.4 → itables-2.2.0}/docs/changelog.md

@@ -1,6 +1,33 @@
 ITables ChangeLog
 =================
 
+2.2.0 (2024-09-22)
+------------------
+
+**Added**
+- ITables has a Jupyter Widget ([#267](https://github.com/mwouts/itables/issues/267)). Our widget was developed and packaged using [AnyWidget](https://anywidget.dev/) which I highly recommend!
+- The selected rows are now available in the apps. Use either the `selected_rows` attribute of the `ITable` widget, the returned value of the Streamlit `interactive_table` component, or the `{table_id}_selected_rows` input in Shiny ([#208](https://github.com/mwouts/itables/issues/208), [#250](https://github.com/mwouts/itables/issues/250))
+- ITables works offline in Shiny applications too - just add `ui.HTML(init_itables())` to your application
+
+**Changed**
+- The `tableId` argument of `to_html_datatable` has been renamed to `table_id`
+
+**Fixed**
+- The dependencies of the Streamlit component have been updated ([#320](https://github.com/mwouts/itables/issues/320))
+
+
+2.1.5 (2024-09-08)
+------------------
+
+**Fixed**
+- DataTables was updated to its latest version (2.1.6)
+- We have added the DateTime extension, required by SearchTime when showing dates ([#288](https://github.com/mwouts/itables/issues/288))
+- We have improved the function that determines whether a dark theme is being used ([#294](https://github.com/mwouts/itables/issues/294))
+- We have adjusted the generation of the Polars sample dataframes to fix the CI ([Polars-18130](https://github.com/pola-rs/polars/issues/18130))
+- The test on the Shiny app fallbacks to `ui.nav_panel` when `ui.nav` is not available
+- The dependencies of the Streamlit component have been updated ([#313](https://github.com/mwouts/itables/issues/313), [#315](https://github.com/mwouts/itables/issues/315))
+
+
 2.1.4 (2024-07-03)
 ------------------
 
@@ -23,7 +50,7 @@ ITables ChangeLog
 an automatic horizontal scrolling in Jupyter, Jupyter Book and also Streamlit if the table is too wide ([#282](https://github.com/mwouts/itables/pull/282)).
 
 **Fixed**
-- The dependencies of the streamlit components have been updated to fix a vulnerability in `ws` ([Alert 1](https://github.com/mwouts/itables/security/dependabot/1))
+- The dependencies of the Streamlit components have been updated to fix a vulnerability in `ws` ([Alert 1](https://github.com/mwouts/itables/security/dependabot/1))
 
 
 2.1.1 (2024-06-08)

itables-2.2.0/docs/dark_mode.md

@@ -0,0 +1,28 @@
+---
+jupytext:
+  formats: md:myst
+  notebook_metadata_filter: -jupytext.text_representation.jupytext_version
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+kernelspec:
+  display_name: itables
+  language: python
+  name: itables
+---
+
+# Dark Themes
+
+When a notebook or application is rendered using a dark theme, DataTable requires that a `dark`
+class be added to the HTML document. This can be done with the following Javascript snippet:
+```javascript
+document.documentElement.classList.add('dark');
+```
+
+When ITables is used in a notebook, this is handled by
+`init_notebook_mode` which displays the [`init_datatables.html`](https://github.com/mwouts/itables/blob/main/src/itables/html/init_datatables.html) snippet.
+
+Please open a PR if you see how to further improve the
+support of light vs dark themes, and e.g. set the `dark`
+class dynamically when the theme is changed.

{itables-2.1.4 → itables-2.2.0}/docs/extensions.md

@@ -105,7 +105,7 @@ show(
 ```{tip}
 Only the filtered or selected rows are exported to CSV/Excel. To filter the rows you
 can use the simple search box, the [SearchPanes](#searchpanes) and [SearchBuilder](#searchbuilder)
-options, or the [select](#row-selection) extension.
+options, or the [select](select.md) extension.
 ```
 
 ```{warning}
@@ -261,32 +261,6 @@ opt.keys = True
 The KeyTable extension works in Jupyter Book (try it here in the documentation) but not in JupyterLab.
 ```
 
-## Row selection
-
-The [select](https://datatables.net/extensions/select) extension let you select rows (or cells). When you do so,
-only the selected rows are exported
-
-```{code-cell}
-:tags: [full-width]
-
-show(df, select=True, buttons=["copyHtml5", "csvHtml5", "excelHtml5"])
-```
-
-```{tip}
-The `select` option accept multiple values, as documented [here](https://datatables.net/extensions/select):
-- `select=True` or `select="os"` let you select using single click, shift-click and ctrl-click
-- `select="single"` let you select a single row
-- `select="multi"` for single click selection of multiple rows, `select="multi+shift"`, ...
-
-With `select={"style": "os", "items": "cell"}` you can let the user select specific cells,
-however cell selection is not taken into account when exporting the data.
-```
-
-```{tip}
-At the moment it is not possible to get the selected rows back in Python. Please subscribe to
-[#250](https://github.com/mwouts/itables/issues/250) to get updates on this topic.
-```
-
 ## RowGroup
 
 Use the [RowGroup](https://datatables.net/extensions/rowgroup/) extension to group

itables-2.2.0/docs/ipywidgets.md

@@ -0,0 +1,118 @@
+---
+jupytext:
+  formats: md:myst
+  notebook_metadata_filter: -jupytext.text_representation.jupytext_version
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+kernelspec:
+  display_name: itables
+  language: python
+  name: itables
+---
+
+# Jupyter Widget
+
+ITables is available as a [Jupyter Widget](https://ipywidgets.readthedocs.io) since v2.2.
+
+## The `ITable` widget
+
+The `ITable` widget has a few dependencies (essentially [AnyWidget](https://anywidget.dev),
+a great widget development framework!) that you can install with
+```bash
+pip install itables[widget]
+```
+
+The `ITable` class accepts the same arguments as the `show` method, but
+the `df` argument is optional.
+
+```{code-cell}
+from itables.sample_dfs import get_dict_of_test_dfs
+from itables.widget import ITable
+
+df = get_dict_of_test_dfs()["int_float_str"]
+
+table = ITable(df, selected_rows=[0, 2, 5], select=True)
+table
+```
+
+## The `selected_rows` traits
+
+The `selected_rows` attribute of the `ITable` object provides a view on the
+rows that have been selected in the table (remember to pass [`select=True`](select.md)
+to activate the row selection). You can use it to either retrieve
+or change the current row selection:
+
+```{code-cell}
+table.selected_rows
+```
+
+```{code-cell}
+table.selected_rows = [3, 4]
+```
+
+## The `df` property
+
+Use it to retrieve the table data:
+
+```{code-cell}
+table.df.iloc[table.selected_rows]
+```
+
+or to update it
+
+```{code-cell}
+table.df = df.head(6)
+```
+
+```{tip}
+`ITable` will raise an `IndexError` if the `selected_rows` are not consistent with the
+updated data. If you need to update the two simultaneously, use `table.update(df, selected_rows=...)`, see below.
+```
+
+## The `caption`, `style` and `classes` traits
+
+You can update these traits from Python, e.g.
+
+```{code-cell}
+table.caption = "numbers and strings"
+```
+
+## The `update` method
+
+Last but not least, you can update the `ITable` arguments simultaneously using the `update` method:
+
+```{code-cell}
+table.update(df.head(20), selected_rows=[7, 8])
+```
+
+## Limitations
+
+Compared to `show`, the `ITable` widget has the same limitations as the [Streamlit component](streamlit.md#limitations),
+e.g. structured headers are not available, you can't pass JavaScript callback, etc.
+
+The good news is that if you only want to _display_ the table, you do not need
+the `ITables` widget. Below is an example in which we use `show` to display a different
+table depending on the value of a drop-down component:
+
+```python
+import ipywidgets as widgets
+from itables import show
+from itables.sample_dfs import get_dict_of_test_dfs
+
+def use_show_in_interactive_output(table_name: str):
+    show(
+        sample_dfs[table_name],
+        caption=table_name,
+    )
+
+sample_dfs = get_dict_of_test_dfs()
+table_selector = widgets.Dropdown(options=sample_dfs.keys(), value="int_float_str")
+
+out = widgets.interactive_output(
+    use_show_in_interactive_output, {"table_name": table_selector}
+)
+
+widgets.VBox([table_selector, out])
+```

{itables-2.1.4 → itables-2.2.0}/docs/quick_start.md

@@ -14,12 +14,13 @@ kernelspec:
 
 ![ITables Logo](../src/itables/logo/text.svg)
 
-![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main)
+[![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main)](https://github.com/mwouts/itables/actions)
 [![codecov.io](https://codecov.io/github/mwouts/itables/coverage.svg?branch=main)](https://codecov.io/github/mwouts/itables?branch=main)
 [![Pypi](https://img.shields.io/pypi/v/itables.svg)](https://pypi.python.org/pypi/itables)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/itables.svg)](https://anaconda.org/conda-forge/itables)
 [![pyversions](https://img.shields.io/pypi/pyversions/itables.svg)](https://pypi.python.org/pypi/itables)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Jupyter Widget](https://img.shields.io/badge/Jupyter-Widget-F37626.svg?style=flat&logo=Jupyter)](ipywidgets.md)
 [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_red.svg)](https://itables.streamlit.app)
 <a class="github-button" href="https://github.com/mwouts/itables" data-icon="octicon-star" data-show-count="true"></a>
 <script src="https://buttons.github.io/buttons.js"></script>

itables-2.2.0/docs/select.md

@@ -0,0 +1,84 @@
+---
+jupytext:
+  formats: md:myst
+  notebook_metadata_filter: -jupytext.text_representation.jupytext_version
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+kernelspec:
+  display_name: itables
+  language: python
+  name: itables
+---
+
+## Row selection
+
+The [select](https://datatables.net/extensions/select) extension let you select rows (or cells). When you do so,
+only the selected rows are exported
+
+```{code-cell}
+from itables import init_notebook_mode, show
+
+init_notebook_mode()
+```
+
+```{code-cell}
+:tags: [hide-input]
+
+import string
+
+import numpy as np
+import pandas as pd
+
+from itables.sample_dfs import get_countries
+
+df = get_countries(html=False)
+# Add columns for the searchPanes demo
+df["climate_zone"] = np.where(
+    df["latitude"].abs() < 23.43615,
+    "Tropical",
+    np.where(
+        df["latitude"].abs() < 35,
+        "Sub-tropical",
+        # Artic circle is 66.563861 but there is no capital there => using 64
+        np.where(df["latitude"].abs() < 64, "Temperate", "Frigid"),
+    ),
+)
+df["hemisphere"] = np.where(df["latitude"] > 0, "North", "South")
+wide_df = pd.DataFrame(
+    {
+        letter: np.random.normal(size=100)
+        for letter in string.ascii_lowercase + string.ascii_uppercase
+    }
+)
+```
+
+```{code-cell}
+:tags: [full-width]
+
+show(
+    df,
+    select=True,
+    selected_rows=[2, 4, 5],
+    buttons=["copyHtml5", "csvHtml5", "excelHtml5"],
+)
+```
+
+```{tip}
+It is possible to get the updated `selected_rows` back in Python but for this you will have to use,
+instead of `show`, either
+- the `ITable` [Jupyter Widget](ipywidgets.md)
+- the `interactive_table` [Streamlit component](streamlit.md)
+- or `DT` in a [Shiny app](shiny.md).
+```
+
+```{tip}
+The `select` option accept multiple values, as documented [here](https://datatables.net/extensions/select):
+- `select=True` or `select="os"` let you select using single click, shift-click and ctrl-click
+- `select="single"` let you select a single row
+- `select="multi"` for single click selection of multiple rows, `select="multi+shift"`, ...
+
+With `select={"style": "os", "items": "cell"}` you can let the user select specific cells,
+however cell selection is not taken into account when exporting the data.
+```

itables-2.2.0/docs/shiny.md

@@ -0,0 +1,22 @@
+# Shiny
+
+You can use ITables in Web applications generated with [Shiny](https://shiny.rstudio.com/py/) for Python with e.g.
+```python
+from shiny import ui
+
+from itables.sample_dfs import get_countries
+from itables.shiny import DT, init_itables
+
+# Load the datatables library and css from the ITables package
+# (use connected=True if you prefer to load it from the internet)
+ui.HTML(init_itables(connected=False))
+
+# Render the table with DT
+ui.HTML(DT(get_countries(html=False)))
+```
+
+If you enable row selection and set an id on your table, e.g. `DT(df, table_id="my_table", select=True)` then
+ITables will provide the list of selected rows at `input.my_table_selected_rows()` (replace `my_table` with your
+own table id).
+
+See also our [tested examples](https://github.com/mwouts/itables/tree/main/tests/sample_python_apps).

itables-2.2.0/docs/streamlit.md

@@ -0,0 +1,51 @@
+# Streamlit
+
+To display Python DataFrames as interactive DataTables in Streamlit applications, use
+
+```
+from itables.streamlit import interactive_table
+```
+
+We have a sample application available at https://itables.streamlit.app (source code [here](https://github.com/mwouts/demo_itables_in_streamlit/blob/main/itables_app.py))
+
+```{div} full-width
+<iframe src="https://itables.streamlit.app?embed=true"
+style="height: 600px; width: 100%;"></iframe>
+```
+
+## Selected rows
+
+This feature was added in ITables v2.2.0.
+
+Use the `selected_rows: list[int]` argument from `interactive_table` to
+select rows when the table is first displayed. Add `select=True` to let the user modify the selection. Then, the `interactive_table` component returns a dict, with a key `"selected_rows"` that points to the updated selection.
+
+## Limitations
+
+In most cases, you will be able to use `interactive_table` in a
+Streamlit application in the same way that you use `show` in notebooks.
+
+Due to implementation constraints, the Streamlit component has some limitations
+that `show` does not have:
+- Pandas Style objects can't be rendered with `interactive_table`. This is because
+the Streamlit component needs to pass the table data to the frontend in JSON format (while Pandas Style objects are formatted using HTML)
+- Similarly, you can't use the `use_to_html` argument in `interactive_table`
+- Complex column headers might look different than in notebooks, and HTML in columns is not supported
+- JavaScript callbacks like custom formatting functions are not supported
+- The interactive table is rendered within an iframe that has a fixed weight. This does not work well with the `lengthMenu` control, nor with the advanced filtering extensions (if that is an issue for you, please subscribe or contribute to [#275](https://github.com/mwouts/itables/issues/275)).
+
+## Workaround
+
+If you hit one of the limitations above, you can fallback to using `to_html_datatable` in combination with Streamlit's `html` function.
+
+Please note that:
+- you will have to specify the table height manually,
+- an internet connection is required when using `to_html_datatable`,
+- the app/table might take longer to display.
+
+A sample application is available at https://to-html-datatable.streamlit.app (source code [here](https://github.com/mwouts/to_html_datatable_in_streamlit/blob/main/itables_app.py))
+
+```{div} full-width
+<iframe src="https://to-html-datatable.streamlit.app?embed=true"
+style="height: 600px; width: 100%;"></iframe>
+```

{itables-2.1.4 → itables-2.2.0}/environment.yml

@@ -25,5 +25,6 @@ dependencies:
   - ghp-import
   - shiny
   - streamlit
+  - anywidget
   - pip:
     - world_bank_data

{itables-2.1.4 → itables-2.2.0}/packages/dt_for_itables/CHANGELOG.md

@@ -1,4 +1,12 @@
-# 2.0.11 (2024-06-??)
+# 2.0.13 (2024-09-22)
+
+- We have added two functions `set_selected_rows` and `get_selected_rows` to set and retrieve selected rows
+
+# 2.0.12 (2024-09-08)
+
+- We have added the datetime extension for DataTables ([#288](https://github.com/mwouts/itables/issues/288))
+
+# 2.0.11 (2024-06-19)
 
 **Added**
 - The default CSS contains has `overflow:auto` on `.dt-layout-table>div`. This improves the horizontal scrolling in Jupyter, and discards the need for `scrollX` in Streamlit ([#282](https://github.com/mwouts/itables/pull/282))

{itables-2.1.4 → itables-2.2.0}/packages/dt_for_itables/README.md

@@ -15,7 +15,7 @@ npm run build:js
 
 Run
 ```bash
-npm update
+npm update --save
 ```
 and check whether there are any outdated package with `npm outdated`.