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

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.tar.gz (3.5 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: streamlit-aggrid-0.2.3.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.tar.gz
Algorithm Hash digest
SHA256 d7bc89a2671e0297d7be19813f1064910209f12bebd86b97fea63daa8ead64fd
MD5 b64dd02164cfd1f35cf6068fde594b86
BLAKE2b-256 9b2c6e18d17f280f0e4eaffebdcbb69aba308213a61833c39daa2f4d4bdcc1a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: streamlit_aggrid-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 3.5 MB
  • Tags: Python 3
  • 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-py3-none-any.whl
Algorithm Hash digest
SHA256 02c9cfa5e035f7ebc73f4d10dffba9412c7a89bdbed0643f5e9421472d6ac621
MD5 a9aedf210c0a3ca857620b048657b891
BLAKE2b-256 6d47b7754126eb0129e17b628299ddcc7302568a894db98f27576357e13e7a1f

See more details on using hashes here.

Supported by

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