{"id":27070,"library":"ipyaggrid","title":"ipyaggrid","description":"ipyaggrid is a Jupyter widget that brings the ag-Grid data grid into Jupyter notebooks. It provides full ag-Grid functionality, including sorting, filtering, editing, and exporting. Current version is 0.5.4, and the library is maintained by Widgetti. Release cadence is irregular.","status":"active","version":"0.5.4","language":"python","source_language":"en","source_url":"https://github.com/widgetti/ipyaggrid","tags":["jupyter","widget","ag-grid","datagrid","notebook"],"install":[{"cmd":"pip install ipyaggrid","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"Grid is directly importable from the top-level package, not from a submodule.","wrong":"from ipyaggrid.grid import Grid","symbol":"Grid","correct":"from ipyaggrid import Grid"}],"quickstart":{"code":"from ipyaggrid import Grid\ngrid = Grid(\n    data={\n        'make': ['Toyota', 'Ford', 'Porsche'],\n        'model': ['Celica', 'Mondeo', 'Boxster'],\n        'price': [35000, 32000, 72000]\n    },\n    grid_options={\n        'columnDefs': [\n            {'field': 'make', 'sortable': True, 'filter': True},\n            {'field': 'model', 'sortable': True, 'filter': True},\n            {'field': 'price', 'sortable': True, 'filter': True}\n        ]\n    }\n)\ngrid","lang":"python","description":"Creates a basic ag-Grid widget with three columns, showing sorting and filtering enabled."},"warnings":[{"fix":"Add 'licenseKey': '__community__' to grid_options when using community edition.","message":"ipyaggrid uses ag-Grid Enterprise features by default, but if you only have the community edition, set `grid_options['licenseKey'] = '__community__'` to avoid console watermark warnings.","severity":"gotcha","affected_versions":">=0.5.0"},{"fix":"Convert data from list of dicts to dict of lists. Use pandas DataFrame and then `df.to_dict('list')` if needed.","message":"In version 0.5.0, the `data` parameter changed from expecting a list of dicts to expecting a dict of columns (column-oriented format). Old code using list of dicts will break.","severity":"breaking","affected_versions":">=0.5.0"},{"fix":"Set `grid_options['quickFilterText'] = 'your_text'` and remove `quick_filter` argument.","message":"The `quick_filter` argument in Grid constructor is deprecated since 0.5.0. Use `grid_options['quickFilterText']` instead.","severity":"deprecated","affected_versions":">=0.5.0"},{"fix":"Upgrade to 0.5.2 or later where defaults are fixed.","message":"When exporting to CSV or Excel using the built-in buttons, the exported file may have the wrong extension if not set properly. Ensure you set `exportDataAsCsv()` or `exportDataAsExcel()` via JavaScript.","severity":"gotcha","affected_versions":"<0.5.2"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Run `pip install ipyaggrid` in the correct environment (e.g., Jupyter kernel's Python).","cause":"The package is not installed or is installed in a different environment.","error":"ModuleNotFoundError: No module named 'ipyaggrid'"},{"fix":"Add 'licenseKey': '__community__' to grid_options to suppress the warning if using community edition.","cause":"ipyaggrid expects an enterprise license key but none provided, and defaults to community with a watermark message in the console.","error":"JavaScript error: ag-Grid: license key not found, using community edition..."},{"fix":"Use `grid_options['quickFilterText']` instead of the `quick_filter` argument.","cause":"The `quick_filter` parameter was removed in version 0.5.0.","error":"TypeError: Grid.__init__() got an unexpected keyword argument 'quick_filter'"},{"fix":"Convert the DataFrame to dict: `data=df.to_dict('list')`.","cause":"Passing a pandas DataFrame directly to `data` parameter without converting to dict.","error":"ValueError: The truth value of a DataFrame is ambiguous."}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}