Skip to main content

Streamlit component implementation of ag-grid

Project description

streamlit-aggrid

Open in Streamlit GitHub PyPI

AgGrid is an awsome grid for web frontend. More information in https://www.ag-grid.com/. Consider purchasing a license from Ag-Grid if you are going to use enterprise features!

Comment on discuss.streamlit.io If you like it or Buy me a beer 🍺!


Some basic documentation is available: https://streamlit-aggrid.readthedocs.io

Install

pip install streamlit-aggrid

Quick Use

Create an example.py file

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 :

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.

example image

Development Notes

Version 0.2.3

  • small fixes
  • Merged PR #44 and #25 (thanks msabramo and 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)
  • 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 and 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
  • Adds support for timedelta columns check example

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)

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
  • It is now possible to inject js functions on gridOptions. Enabling advanced customizations such as conditional formating (check 4th column on the example)

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...

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

streamlit-aggrid-0.2.3.post2.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

streamlit_aggrid-0.2.3.post2-py3-none-any.whl (3.5 MB view details)

Uploaded Python 3

File details

Details for the file streamlit-aggrid-0.2.3.post2.tar.gz.

File metadata

  • Download URL: streamlit-aggrid-0.2.3.post2.tar.gz
  • Upload date:
  • Size: 3.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.2 Linux/4.4.0-19041-Microsoft

File hashes

Hashes for streamlit-aggrid-0.2.3.post2.tar.gz
Algorithm Hash digest
SHA256 c67936173a3b7fa9878b55d45a6c4ccfa8505680767e34a026aa27c4cea9b9f7
MD5 53d2e4778e07ca1bca5e744fa882b6ee
BLAKE2b-256 f9927d4b3062b79eb31acd4bff7093867112d42566aac41366f1aa93634cccb8

See more details on using hashes here.

File details

Details for the file streamlit_aggrid-0.2.3.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_aggrid-0.2.3.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 9f2b3f37d50ffe973fcaeff0117eb213ac3d957549293f127f0b67c502944292
MD5 aa747777978118061002bf45a3d0f3f5
BLAKE2b-256 4756a4f325d086c9483ade6d7e904a0bc899b02ef3820c243752b917354cc3d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page