# streamlit-aggrid
[![Open in Streamlit][share_badge]][share_link] [![GitHub][github_badge]][github_link] [![PyPI][pypi_badge]][pypi_link] [![Downloads][downloads_badge]][downloads_link]
---
> [!WARNING]
> v1.0.0 breaks compatibility with previous versions and many people reached me to say that it is unstable.
> Main changes are on gridReturn object as I'm moving heavy processment to python side.
> I'm working to stabilize it, if you find any issues, please open a topic on the issue tracker
> with a reproductile example, if possible.
> Meanwhile use the last v.0.3.4 if things are not working for you! I hope to have everything fixed soon.
If you want to sponsor or support this project you can [mail me](mailto:pablo.fonseca+staggrid@gmail.com).
You may want to [Buy me a coffee](https://www.buymeacoffee.com/pablofonseca) or [Paypal](https://www.paypal.com/donate?hosted_button_id=8HGLA4JZBYFPQ)
Live examples and documentation [on Streamlit Cloud](https://staggrid-examples.streamlit.app/)
---
**AgGrid** is an awesome grid for web frontend. More information in [https://www.ag-grid.com/](https://www.ag-grid.com/). Consider purchasing a license from Ag-Grid if you are going to use enterprise features!
Current AgGrid version is [31.3.0](https://www.ag-grid.com/archive/31.3.0/)
# Install
```
pip install streamlit-aggrid
```
# Quick Use
Create an example.py file
```python
from st_aggrid import AgGrid
import pandas as pd
df = pd.read_csv('https://raw.githubusercontent.com/fivethirtyeight/data/master/airline-safety/airline-safety.csv')
AgGrid(df)
```
Run :
```shell
streamlit run example.py
```
# Demo
Grid data is sent back to streamlit and can be reused in other components. In the example below a chart is updated on grid edition.
# Development Notes
Version 1.0.5
- Updated AgGrid to version 31.3
Version 1.0.4
- Added information on the event that triggered app rerun
Version 1.0.2
- Moved a lot of response processment to python side.
- Changed grid return object.
- Fix bugs and code cleanup.
Version 0.3.5
- Merged many PR, thanks everybody.
- Grid State can be saved and retrieved. Many people requested this one. Live Example [Here](https://staggrid-examples.streamlit.app/?example=%27Grid%20State%27)
Version 0.3.4
- Added quickfilter
- Added Excel Export Module
- Bugfixes (an probably introduced new ones :/)
- Code cleanup
- Updated Ag-Grit to 29.1.0 (including ag-grid-react) which will cause direct HTML returns to stop rendering ([#198](https://github.com/PablocFonseca/streamlit-aggrid/issues/198)). Use a [cellRenderer](https://www.ag-grid.com/javascript-data-grid/component-cell-renderer/) instead.
Version 0.3.3
- Fixes [#132](https://github.com/PablocFonseca/streamlit-aggrid/issues/132)
- Fixes [#131](https://github.com/PablocFonseca/streamlit-aggrid/issues/131) and [#130](https://github.com/PablocFonseca/streamlit-aggrid/issues/130)
- Added Sparklines [#118](https://github.com/PablocFonseca/streamlit-aggrid/issues/118)
- Changed Grid Return to support [#117](https://github.com/PablocFonseca/streamlit-aggrid/issues/117)
- Rebuilt streamlit theme
Version 0.3.0
- Merged some PR (Thanks everybody!) check PR at github!
- Added class parsing in React Side, so more advanced CellRenderers can be used. (Thanks [kjakaitis](https://github.com/kjakaitis))
- Added gridOptionsBuilder.configure_first_column_as_index() to, well, style the first columns as an index (MultiIndex to come!)
- Improved serialization performance by using simpler pandas to_json method (PR #62, #85)
- Added option to render plain json instead of pd.dataframes
- gridOptions may be loaded from file paths or strings
- gridReturn is now a @dataclass with rowIndex added to selected_rows, (previous version returned only the selected data, now you can know which row was selected)
- Changed GridReturnMode behavior. Now update_on accepts a list of gridEvents that will trigger a streamlit refresh, making it possible to subscribe to any [gridEvent](https://www.ag-grid.com/javascript-data-grid/grid-events/).
- Removed dot-env and simplejson dependencies.
- Other smaller fixes and typos corrections.
Version 0.2.3
- small fixes
- Merged PR #44 and #25 (thanks [msabramo](https://github.com/msabramo) and [ljnsn](https://github.com/ljnsn))
- Merged PR #58 - allow nesting dataframes. Included an example in exampes folder.
Version 0.2.2
- Updated frontend dependencies to latest version
- Corrected text color for better viz when using streamlit theme (thanks [jasonpmcculloch](https://github.com/jasonpmcculloch))
- Switched default theme to Balham Light ('light'), if you want to use streamlit theme set `theme='streamlit'` on agGrid call
Version 0.2.0
- Support Themes
- Incorporated Pull Requests with fixes and pre-select rows (Thanks [randomseed42](https://github.com/randomseed42) and [msabramo](https://github.com/msabramo))
- You can use strings instead of importing GridUpdateMode and DataReturnMode enumerators
- it works fine with st.forms!
- new theme example in example folder
Version 0.1.9
- Small fixes
- Organized examples folder
Version 0.1.8
- Fixes a bug that breaks the grid when NaN or Inf values are present in the data
Version 0.1.7
- Fixes a bug that happened when converting data back from the grid with only one row
- Added license_key parameter on AgGrid call.
Version 0.1.6
- Fixes issue [#3](https://github.com/PablocFonseca/streamlit-aggrid/issues/3)
- Adds support for timedelta columns check [example][share_link]
Version 0.1.5
- small bug fixes
- there is an option to avoid grid re-initialization on app update (check fixed_key_example.py on examples folder or [here](https://share.streamlit.io/pablocfonseca/streamlit-aggrid/main/examples/fixed_key_example.py))
Version 0.1.3
- Fixed bug where cell was blank after edition.
- Added enable_enterprise_modules argument to AgGrid call for enabling/disabling [enterprise features](https://www.ag-grid.com/documentation/javascript/licensing/)
- It is now possible to inject js functions on gridOptions. Enabling advanced customizations such as conditional formatting (check 4<sup>th</sup> column on the [example](share_link))
Version 0.1.2
- added customCurrencyFormat as column type
Version 0.1.0:
- I worked a little bit more on making the example app functional.
- Couple configuration options for update mode (How frontend updates streamlit) and for data returns (grid should return data filtered? Sorted?)
- Some basic level of row selection
- Added some docstrings specially on gridOptionsBuilder methods
- Lacks performance for production. JS Client code is slow...
[share_badge]: https://static.streamlit.io/badges/streamlit_badge_black_white.svg
[share_link]: https://staggrid-examples.streamlit.app/
[github_badge]: https://badgen.net/badge/icon/GitHub?icon=github&color=black&label
[github_link]: https://github.com/PablocFonseca/streamlit-aggrid
[pypi_badge]: https://badgen.net/pypi/v/streamlit-aggrid?icon=pypi&color=black&label?
[pypi_link]: https://www.pypi.org/project/streamlit-aggrid/
[downloads_badge]: https://img.shields.io/pypi/dm/streamlit-aggrid
[downloads_link]: https://pypi.org/project/streamlit-aggrid/#files
Raw data
{
"_id": null,
"home_page": "https://github.com/PablocFonseca/streamlit-aggrid",
"name": "streamlit-aggrid",
"maintainer": null,
"docs_url": null,
"requires_python": "!=2.7.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Pablo Fonseca",
"author_email": "pablo.fonseca+pip@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9c/6a/1d400578115fea4b8926fe60566d54399409baadaf448ed0bc07e0130312/streamlit_aggrid-1.0.5.tar.gz",
"platform": null,
"description": "# streamlit-aggrid\n\n[![Open in Streamlit][share_badge]][share_link] [![GitHub][github_badge]][github_link] [![PyPI][pypi_badge]][pypi_link] [![Downloads][downloads_badge]][downloads_link]\n\n---\n> [!WARNING] \n> v1.0.0 breaks compatibility with previous versions and many people reached me to say that it is unstable. \n> Main changes are on gridReturn object as I'm moving heavy processment to python side. \n> I'm working to stabilize it, if you find any issues, please open a topic on the issue tracker \n> with a reproductile example, if possible. \n> Meanwhile use the last v.0.3.4 if things are not working for you! I hope to have everything fixed soon. \n\n\nIf you want to sponsor or support this project you can [mail me](mailto:pablo.fonseca+staggrid@gmail.com). \nYou may want to [Buy me a coffee](https://www.buymeacoffee.com/pablofonseca) or [Paypal](https://www.paypal.com/donate?hosted_button_id=8HGLA4JZBYFPQ)\n\nLive examples and documentation [on Streamlit Cloud](https://staggrid-examples.streamlit.app/)\n\n---\n\n**AgGrid** is an awesome grid for web frontend. More information in [https://www.ag-grid.com/](https://www.ag-grid.com/). Consider purchasing a license from Ag-Grid if you are going to use enterprise features!\n\nCurrent AgGrid version is [31.3.0](https://www.ag-grid.com/archive/31.3.0/)\n\n# Install\n\n```\npip install streamlit-aggrid\n\n```\n\n# Quick Use\n\nCreate an example.py file\n\n```python\nfrom st_aggrid import AgGrid\nimport pandas as pd\n\ndf = pd.read_csv('https://raw.githubusercontent.com/fivethirtyeight/data/master/airline-safety/airline-safety.csv')\nAgGrid(df)\n```\n\nRun :\n\n```shell\nstreamlit run example.py\n```\n\n# Demo\n\nGrid data is sent back to streamlit and can be reused in other components. In the example below a chart is updated on grid edition.\n\n\n\n# Development Notes\nVersion 1.0.5\n- Updated AgGrid to version 31.3\n\nVersion 1.0.4\n - Added information on the event that triggered app rerun\n\n\nVersion 1.0.2\n - Moved a lot of response processment to python side.\n - Changed grid return object.\n - Fix bugs and code cleanup.\n\nVersion 0.3.5\n - Merged many PR, thanks everybody.\n - Grid State can be saved and retrieved. Many people requested this one. Live Example [Here](https://staggrid-examples.streamlit.app/?example=%27Grid%20State%27) \n\n\nVersion 0.3.4\n\n- Added quickfilter\n- Added Excel Export Module\n- Bugfixes (an probably introduced new ones :/)\n- Code cleanup\n- Updated Ag-Grit to 29.1.0 (including ag-grid-react) which will cause direct HTML returns to stop rendering ([#198](https://github.com/PablocFonseca/streamlit-aggrid/issues/198)). Use a [cellRenderer](https://www.ag-grid.com/javascript-data-grid/component-cell-renderer/) instead.\n\nVersion 0.3.3\n\n- Fixes [#132](https://github.com/PablocFonseca/streamlit-aggrid/issues/132)\n- Fixes [#131](https://github.com/PablocFonseca/streamlit-aggrid/issues/131) and [#130](https://github.com/PablocFonseca/streamlit-aggrid/issues/130)\n- Added Sparklines [#118](https://github.com/PablocFonseca/streamlit-aggrid/issues/118)\n- Changed Grid Return to support [#117](https://github.com/PablocFonseca/streamlit-aggrid/issues/117)\n- Rebuilt streamlit theme\n\nVersion 0.3.0\n\n- Merged some PR (Thanks everybody!) check PR at github!\n- Added class parsing in React Side, so more advanced CellRenderers can be used. (Thanks [kjakaitis](https://github.com/kjakaitis))\n- Added gridOptionsBuilder.configure_first_column_as_index() to, well, style the first columns as an index (MultiIndex to come!)\n- Improved serialization performance by using simpler pandas to_json method (PR #62, #85)\n- Added option to render plain json instead of pd.dataframes\n- gridOptions may be loaded from file paths or strings\n- gridReturn is now a @dataclass with rowIndex added to selected_rows, (previous version returned only the selected data, now you can know which row was selected)\n- Changed GridReturnMode behavior. Now update_on accepts a list of gridEvents that will trigger a streamlit refresh, making it possible to subscribe to any [gridEvent](https://www.ag-grid.com/javascript-data-grid/grid-events/).\n- Removed dot-env and simplejson dependencies.\n- Other smaller fixes and typos corrections.\n\nVersion 0.2.3\n\n- small fixes\n- Merged PR #44 and #25 (thanks [msabramo](https://github.com/msabramo) and [ljnsn](https://github.com/ljnsn))\n- Merged PR #58 - allow nesting dataframes. Included an example in exampes folder.\n\nVersion 0.2.2\n\n- Updated frontend dependencies to latest version\n- Corrected text color for better viz when using streamlit theme (thanks [jasonpmcculloch](https://github.com/jasonpmcculloch))\n- Switched default theme to Balham Light ('light'), if you want to use streamlit theme set `theme='streamlit'` on agGrid call\n\nVersion 0.2.0\n\n- Support Themes\n- Incorporated Pull Requests with fixes and pre-select rows (Thanks [randomseed42](https://github.com/randomseed42) and [msabramo](https://github.com/msabramo))\n- You can use strings instead of importing GridUpdateMode and DataReturnMode enumerators\n- it works fine with st.forms!\n- new theme example in example folder\n\nVersion 0.1.9\n\n- Small fixes\n- Organized examples folder\n\nVersion 0.1.8\n\n- Fixes a bug that breaks the grid when NaN or Inf values are present in the data\n\nVersion 0.1.7\n\n- Fixes a bug that happened when converting data back from the grid with only one row\n- Added license_key parameter on AgGrid call.\n\nVersion 0.1.6\n\n- Fixes issue [#3](https://github.com/PablocFonseca/streamlit-aggrid/issues/3)\n- Adds support for timedelta columns check [example][share_link]\n\nVersion 0.1.5\n\n- small bug fixes\n- there is an option to avoid grid re-initialization on app update (check fixed_key_example.py on examples folder or [here](https://share.streamlit.io/pablocfonseca/streamlit-aggrid/main/examples/fixed_key_example.py))\n\nVersion 0.1.3\n\n- Fixed bug where cell was blank after edition.\n- Added enable_enterprise_modules argument to AgGrid call for enabling/disabling [enterprise features](https://www.ag-grid.com/documentation/javascript/licensing/)\n- It is now possible to inject js functions on gridOptions. Enabling advanced customizations such as conditional formatting (check 4<sup>th</sup> column on the [example](share_link))\n\nVersion 0.1.2\n\n- added customCurrencyFormat as column type\n\nVersion 0.1.0:\n\n- I worked a little bit more on making the example app functional.\n- Couple configuration options for update mode (How frontend updates streamlit) and for data returns (grid should return data filtered? Sorted?)\n- Some basic level of row selection\n- Added some docstrings specially on gridOptionsBuilder methods\n- Lacks performance for production. JS Client code is slow...\n\n[share_badge]: https://static.streamlit.io/badges/streamlit_badge_black_white.svg\n[share_link]: https://staggrid-examples.streamlit.app/\n[github_badge]: https://badgen.net/badge/icon/GitHub?icon=github&color=black&label\n[github_link]: https://github.com/PablocFonseca/streamlit-aggrid\n[pypi_badge]: https://badgen.net/pypi/v/streamlit-aggrid?icon=pypi&color=black&label?\n[pypi_link]: https://www.pypi.org/project/streamlit-aggrid/\n[downloads_badge]: https://img.shields.io/pypi/dm/streamlit-aggrid\n[downloads_link]: https://pypi.org/project/streamlit-aggrid/#files\n",
"bugtrack_url": null,
"license": null,
"summary": "Streamlit component implementation of ag-grid",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/PablocFonseca/streamlit-aggrid"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f49892f841d7eb689fb67d83c310c1846423bb14c7fc9976b83b0d0ede1ed24",
"md5": "4812f0069d84d3463f9c0a69f565503e",
"sha256": "ac0a58c1d39418d139da5623c4c8a0a3aa86463c217a41c837e2ef52c8537a34"
},
"downloads": -1,
"filename": "streamlit_aggrid-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4812f0069d84d3463f9c0a69f565503e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=2.7.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3.8",
"size": 7903624,
"upload_time": "2024-05-06T23:06:01",
"upload_time_iso_8601": "2024-05-06T23:06:01.688447Z",
"url": "https://files.pythonhosted.org/packages/6f/49/892f841d7eb689fb67d83c310c1846423bb14c7fc9976b83b0d0ede1ed24/streamlit_aggrid-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c6a1d400578115fea4b8926fe60566d54399409baadaf448ed0bc07e0130312",
"md5": "07f465caf1488c412ca69272a8c0fbbe",
"sha256": "12e17f88d66e110e5d68504614a4b933f7dca31e40448396252d889a10e761b6"
},
"downloads": -1,
"filename": "streamlit_aggrid-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "07f465caf1488c412ca69272a8c0fbbe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=2.7.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3.8",
"size": 7819216,
"upload_time": "2024-05-06T23:06:13",
"upload_time_iso_8601": "2024-05-06T23:06:13.999154Z",
"url": "https://files.pythonhosted.org/packages/9c/6a/1d400578115fea4b8926fe60566d54399409baadaf448ed0bc07e0130312/streamlit_aggrid-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 23:06:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PablocFonseca",
"github_project": "streamlit-aggrid",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "streamlit-aggrid"
}
JSON
