Interactive Tables in Jupyter
Project description
Interactive Tables
Pandas DataFrames and Series as interactive datatables!
Documentation
Browse the documentation to see examples of Pandas datatables rendered as interactive datatables.
Quick start
Install the itables
package with either
pip install itables
or
conda install itables -c conda-forge
Activate the interactive mode for all series and dataframes with
from itables import init_notebook_mode
init_notebook_mode(all_interactive=True)
and then render any Pandas DataFrame as an interactive table that you can sort, search and explore:
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:
Since itables==1.0.0
, the jquery and 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.
If you prefer to load the libraries dynamically (and keep the notebook lighter), use connected=True
when you
execute init_notebook_mode
.
Supported environments
itables
has been tested in the following editors:
- Jupyter Notebook
- Jupyter Lab
- Jupyter nbconvert (i.e. the tables are still interactive in the HTML export of a notebook)
- Jupyter Book
- Google Colab
- VS Code (for both Jupyter Notebooks and Python scripts)
- PyCharm (for Jupyter Notebooks)
Try ITables on Binder
You can run our examples notebooks directly on , without having to install anything on your side.
Table not loading?
If the table just says "Loading...", then maybe
- You loaded a notebook that is not trusted (run "Trust Notebook" in View / Activate Command Palette)
- You forgot to run
init_notebook_mode
, or you deleted that cell or its output - Or you ran
init_notebook_mode(connected=True)
but you are not connected to the internet?
Please note that if you change the value of the connected
argument in
the init_notebook_mode
cell, you will need to re-execute all the cells
that display interactive tables.
If the above does not help, please check out the ChangeLog
and decide whether you should upgrade itables
.
Downsampling
When the data in a table is larger than maxBytes
, which is equal to 64KB by default, itables
will display only a subset of the table - one that fits into maxBytes
. If you wish, you can deactivate the limit with maxBytes=0
, change the value of maxBytes
, or similarly set a limit on the number of rows (maxRows
, defaults to 0) or columns (maxColumns
, defaults to pd.get_option('display.max_columns')
).
Note that datatables support server-side processing. At a later stage we may implement support for larger tables using this feature.
from itables.sample_dfs import get_indicators
import itables.options as opt
opt.lengthMenu = [2, 5, 10, 20, 50, 100, 200, 500]
opt.maxBytes = 10000
df = get_indicators()
df.values.nbytes
df
To show the table in full, we can modify the value of maxBytes
either locally:
show(df, maxBytes=0)
or globally:
opt.maxBytes = 2 ** 20
df
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file itables-1.3.4.tar.gz
.
File metadata
- Download URL: itables-1.3.4.tar.gz
- Upload date:
- Size: 191.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.7.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50ee8b91e87d8ede7555e272fa0dfc3ece1f842005a9d707d7dc84f77c669872 |
|
MD5 | 1376a6661dd91fdc6fe8023d99f632b9 |
|
BLAKE2b-256 | df1e265a941d22f6d9e933d9a6e40b4a064c783bb99fd505b46bf7411582fb0b |
File details
Details for the file itables-1.3.4-py3-none-any.whl
.
File metadata
- Download URL: itables-1.3.4-py3-none-any.whl
- Upload date:
- Size: 193.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.7.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b63ed1a67596416e64f956fec68dbd5e2a8056c57cb372719dfd20576bb9dda |
|
MD5 | ddab337d6958984e75d832118072067f |
|
BLAKE2b-256 | ee79a670943818c391f9573327c4fef96ec04d8ead9a5e5351a2aacdd9f09846 |