Itables works with Shiny for Python (#92)

* New function 'to_html_datatable'

* ITables works with Shiny

* Skip sample apps test in Python 3.6

Author: mwouts

docs/changelog.md

@@ -1,6 +1,14 @@
 ITables ChangeLog
 =================
 
+1.2.0 (2022-08-15)
+------------------
+
+**Added**
+- New `to_html_datatable` function to export a DataFrame to an HTML div (#88)
+- We have added examples on how to use `itables` in [Shiny](https://shiny.rstudio.com/py/) for Python (#86)
+
+
 1.1.3 (2022-08-11)
 ------------------
 

docs/supported_editors.md

@@ -42,3 +42,20 @@ In PyCharm we recommend to call `init_notebook_mode` with the `connected=True` a
 because otherwise the notebooks do not display the interactive tables when they are reloaded.
 
 ![](images/pycharm.png)
+
+# Exporting a DataFrame to an HTML table
+
+To get the HTML representation of a Pandas DataFrame `df` as an interactive [datatable](https://datatables.net/), you can use `to_html_datatable` as below:
+```python
+from itables import to_html_datatable as DT
+from itables.sample_dfs import get_countries
+
+df = get_countries()
+html = DT(df)
+```
+
+# Using ITables in Shiny
+
+You can use ITables in Web applications generated with [Shiny](https://shiny.rstudio.com/py/) for Python, see our [tested examples](https://github.com/mwouts/itables/tree/main/tests/sample_python_apps).
+
+ITables can't be used in Dash because jQuery is not usable in Dash (see the [Dash FAQ](https://dash.plotly.com/faqs)).

environment.yml

@@ -23,6 +23,8 @@ dependencies:
   - setuptools
   - twine
   - ghp-import
+  # Interactive applications
+  - shiny
   - pip:
     - world_bank_data
     - jupyter_book>=0.12  # jupyter-book-0.12.2-pyhd8ed1ab_0 requires jupytext >=1.11.2,<1.12

itables/__init__.py

@@ -1,4 +1,10 @@
-from .javascript import JavascriptFunction, init_notebook_mode, show
+from .javascript import JavascriptFunction, init_notebook_mode, show, to_html_datatable
 from .version import __version__
 
-__all__ = ["__version__", "show", "init_notebook_mode", "JavascriptFunction"]
+__all__ = [
+    "__version__",
+    "to_html_datatable",
+    "show",
+    "init_notebook_mode",
+    "JavascriptFunction",
+]

itables/javascript.py

@@ -220,8 +220,11 @@ def __init__(self, value):
 
 
 def _datatables_repr_(df=None, tableId=None, **kwargs):
-    """Return the HTML/javascript representation of the table"""
+    return to_html_datatable(df, tableId, connected=_CONNECTED, **kwargs)
 
+
+def to_html_datatable(df=None, tableId=None, connected=True, **kwargs):
+    """Return the HTML representation of the given dataframe as an interactive datatable"""
     # Default options
     for option in dir(opt):
         if option not in kwargs and not option.startswith("__"):
@@ -264,7 +267,7 @@ def _datatables_repr_(df=None, tableId=None, **kwargs):
         kwargs["paging"] = False
 
     # Load the HTML template
-    if _CONNECTED:
+    if connected:
         output = read_package_file("html/datatables_template_connected.html")
     else:
         output = read_package_file("html/datatables_template.html")
@@ -337,5 +340,5 @@ def _datatables_repr_(df=None, tableId=None, **kwargs):
 
 def show(df=None, **kwargs):
     """Show a dataframe"""
-    html = _datatables_repr_(df, **kwargs)
+    html = to_html_datatable(df, connected=_CONNECTED, **kwargs)
     display(HTML(html))

itables/version.py

@@ -1,3 +1,3 @@
 """ITables' version number"""
 
-__version__ = "1.1.3"
+__version__ = "1.2.0"

requirements-dev.txt

@@ -9,3 +9,4 @@ nbconvert
 jupyter_client
 ipykernel
 world_bank_data
+shiny

tests/sample_python_apps/itables_in_a_shiny_app.py

@@ -0,0 +1,11 @@
+from shiny import App, ui
+
+from itables import to_html_datatable as DT
+from itables.sample_dfs import get_countries
+
+df = get_countries()
+
+app_ui = ui.page_fluid(ui.HTML(DT(df)))
+
+app = App(app_ui, server=None)
+# app.run()

tests/sample_python_apps/itables_in_a_shiny_app_with_tabs.py

@@ -0,0 +1,14 @@
+from shiny import App, ui
+
+from itables import to_html_datatable as DT
+from itables.sample_dfs import get_dict_of_test_dfs
+
+app_ui = ui.page_fluid(
+    # Display the different tables in different tabs
+    ui.navset_tab(
+        *[ui.nav(name, ui.HTML(DT(df))) for name, df in get_dict_of_test_dfs().items()]
+    )
+)
+
+app = App(app_ui, server=None)
+# app.run()

tests/test_javascript.py

@@ -3,8 +3,8 @@
 from itables import javascript
 
 
-def test_datatables_repr_max_columns_none():
+def test_to_html_datatable_max_columns_none():
     test_df = pd.DataFrame([1, 2])
     with pd.option_context("display.max_columns", None):
-        html = javascript._datatables_repr_(test_df)
+        html = javascript.to_html_datatable(test_df)
         assert html