| Name | itables JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | Pandas and Polar DataFrames as interactive DataTables |
| upload_time | 2024-04-30 21:47:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2019-2024 Marc Wouts Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
datatables
interactive
javascript
pandas
polars
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://codecov.io/github/mwouts/itables?branch=main)
[](https://pypi.python.org/pypi/itables)
[](https://anaconda.org/conda-forge/itables)
[](https://pypi.python.org/pypi/itables)
[](https://github.com/psf/black)
This packages changes how Pandas and Polars DataFrames are rendered in Jupyter Notebooks.
With `itables` you can display your tables as interactive [DataTables](https://datatables.net/)
that you can sort, paginate, scroll or filter.
ITables is just about how tables are displayed. You can turn it on and off in just two lines,
with no other impact on your data workflow.
The `itables` package only depends on `numpy`, `pandas` and `IPython`
which you must already have if you work with Pandas in Jupyter (add `polars`, `pyarrow` if you
work with Polars DataFrames).
## Documentation
Browse the [documentation](https://mwouts.github.io/itables/) to see
examples of Pandas or Polars DataFrames rendered as interactive DataTables.
## Quick start
Install the `itables` package with either
```shell
pip install itables
```
or
```shell
conda install itables -c conda-forge
```
Activate the interactive mode for all series and dataframes with
```python
from itables import init_notebook_mode
init_notebook_mode(all_interactive=True)
```
and then render any 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](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.
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)
- Quarto
- Shiny for Python
Raw data
{
"_id": null,
"home_page": null,
"name": "itables",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Marc Wouts <marc.wouts@gmail.com>",
"keywords": "DataTables, Interactive, Javascript, Pandas, Polars",
"author": null,
"author_email": "Marc Wouts <marc.wouts@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a7/70/cacc01bb6895c6a5c6db8f05dbbbea1fbf9355c92d8cdd94c01209f1c832/itables-2.0.1.tar.gz",
"platform": null,
"description": "\n\n\n[](https://codecov.io/github/mwouts/itables?branch=main)\n[](https://pypi.python.org/pypi/itables)\n[](https://anaconda.org/conda-forge/itables)\n[](https://pypi.python.org/pypi/itables)\n[](https://github.com/psf/black)\n\nThis packages changes how Pandas and Polars DataFrames are rendered in Jupyter Notebooks.\nWith `itables` you can display your tables as interactive [DataTables](https://datatables.net/)\nthat you can sort, paginate, scroll or filter.\n\nITables is just about how tables are displayed. You can turn it on and off in just two lines,\nwith no other impact on your data workflow.\n\nThe `itables` package only depends on `numpy`, `pandas` and `IPython`\nwhich you must already have if you work with Pandas in Jupyter (add `polars`, `pyarrow` if you\nwork with Polars DataFrames).\n\n## Documentation\n\nBrowse the [documentation](https://mwouts.github.io/itables/) to see\nexamples of Pandas or Polars DataFrames rendered as interactive DataTables.\n\n## Quick start\n\nInstall the `itables` package with either\n```shell\npip install itables\n```\n\nor\n```shell\nconda install itables -c conda-forge\n```\n\nActivate the interactive mode for all series and dataframes with\n```python\nfrom itables import init_notebook_mode\n\ninit_notebook_mode(all_interactive=True)\n```\nand then render any DataFrame as an interactive table that you can sort, search and explore:\n\n\nIf you prefer to render only selected DataFrames as interactive tables, use `itables.show` to show just one Series or DataFrame as an interactive table:\n\n\nSince `itables==1.0.0`, the [jQuery](https://jquery.com/) and [DataTables](https://datatables.net/) libraries and CSS\nare injected in the notebook when you execute `init_notebook_mode` with its default argument `connected=False`.\nThanks to this the interactive tables will work even without a connection to the internet.\n\nIf you prefer to load the libraries dynamically (and keep the notebook lighter), use `connected=True` when you\nexecute `init_notebook_mode`.\n\n## Supported environments\n\n`itables` has been tested in the following editors:\n- Jupyter Notebook\n- Jupyter Lab\n- Jupyter nbconvert (i.e. the tables are still interactive in the HTML export of a notebook)\n- Jupyter Book\n- Google Colab\n- VS Code (for both Jupyter Notebooks and Python scripts)\n- PyCharm (for Jupyter Notebooks)\n- Quarto\n- Shiny for Python\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019-2024 Marc Wouts Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Pandas and Polar DataFrames as interactive DataTables",
"version": "2.0.1",
"project_urls": {
"Changelog": "https://github.com/mwouts/itables/blob/main/docs/changelog.md",
"Documentation": "https://mwouts.github.io/itables",
"Homepage": "https://mwouts.github.io/itables/",
"Issues": "https://github.com/mwouts/itables/issues",
"Repository": "https://github.com/mwouts/itables.git"
},
"split_keywords": [
"datatables",
" interactive",
" javascript",
" pandas",
" polars"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71a8589e34340f3631d73365c98c2027d177e1d9b10c15bb6823283dce690287",
"md5": "624e44a5ce03677ea02f7453552f403e",
"sha256": "ab99561f088eb7dbfca6f24f894a80929fd8c3198f55126441057366e0718bec"
},
"downloads": -1,
"filename": "itables-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "624e44a5ce03677ea02f7453552f403e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 221658,
"upload_time": "2024-04-30T21:47:38",
"upload_time_iso_8601": "2024-04-30T21:47:38.725701Z",
"url": "https://files.pythonhosted.org/packages/71/a8/589e34340f3631d73365c98c2027d177e1d9b10c15bb6823283dce690287/itables-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a770cacc01bb6895c6a5c6db8f05dbbbea1fbf9355c92d8cdd94c01209f1c832",
"md5": "d54842f157143d0c115b1626f1d956b8",
"sha256": "dae51872275f7d2a7be7159c280a67ae369ec31bb0d3b87042c5919f6de201a3"
},
"downloads": -1,
"filename": "itables-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d54842f157143d0c115b1626f1d956b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1081795,
"upload_time": "2024-04-30T21:47:41",
"upload_time_iso_8601": "2024-04-30T21:47:41.419462Z",
"url": "https://files.pythonhosted.org/packages/a7/70/cacc01bb6895c6a5c6db8f05dbbbea1fbf9355c92d8cdd94c01209f1c832/itables-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 21:47:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mwouts",
"github_project": "itables",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "itables"
}
