Unofficial backend utilities for using Material-UI's X-Data-Grid component
Project description
MUI Data Grid
This is an unofficial toolbox to make integrating a Python web application with Material UI's data grid simpler.
Documentation
Requirements
- Python 3.7+
Installation
Pip
python -m pip install -U 'mui-data-grid'
or with extras:
python -m pip install -U 'mui-data-grid[flask]'
python -m pip install -U 'mui-data-grid[sqlalchemy]'
python -m pip install -U 'mui-data-grid[flask, sqlalchemy]'
Poetry
poetry add mui-data-grid
Usage
Integrations
Flask
#!/usr/bin/env python
# examples/main.py
from flask import Flask, jsonify
from flask.wrappers import Response
from mui.v5.integrations.flask import get_grid_models_from_request
app = Flask(__name__)
FILTER_MODEL_KEY = "filter_model"
SORT_MODEL_KEY = "sort_model[]"
PAGINATION_MODEL_KEY = None # stored inline in the query string, not encoded as an obj
@app.route("/")
def print_sorted_details() -> Response:
# models will return default values if the keys don't exist,
# so you can choose what features you integrate, and when.
models = get_grid_models_from_request(
filter_model_key=FILTER_MODEL_KEY,
pagination_model_key=PAGINATION_MODEL_KEY,
sort_model_key=SORT_MODEL_KEY,
)
return jsonify(
{
# sort_model is a list[GridSortItem]
SORT_MODEL_KEY: [model.dict() for model in models.sort_model],
# filter_model is GridFilterModel
FILTER_MODEL_KEY: models.filter_model.dict(),
# pagination_model is a GridPaginationModel
# providing a consistent interface to pagination parameters
PAGINATION_MODEL_KEY: models.pagination_model,
}
)
if __name__ == "__main__":
app.run()
SQLAlchemy
# please see examples/main.py for the full code
models = get_grid_models_from_request(
filter_model_key=FILTER_MODEL_KEY,
pagination_model_key=PAGINATION_MODEL_KEY,
sort_model_key=SORT_MODEL_KEY,
)
session = Session()
try:
base_query = session.query(ExampleModel)
dg_query = apply_request_grid_models_to_query(
query=base_query,
request_model=models,
column_resolver=example_model_resolver,
)
# we calculate total separately so that we can re-use the result
# rather than have .pages() fire off an additional db query.
total = dg_query.total()
def item_factory(item: ExampleModel) -> Dict[str, int]:
return item.dict()
return jsonify(
{
"items": dg_query.items(factory=item_factory),
"page": dg_query.page,
"pageSize": dg_query.page_size,
"pages": dg_query.pages(total=total),
"total": total,
}
)
finally:
session.close()
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
mui_data_grid-0.6.5.tar.gz
(20.5 kB
view hashes)
Built Distribution
Close
Hashes for mui_data_grid-0.6.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 715f753faaba77943da700db3b0a3e9054f96d976c6a32e6669f4a3697c155f4 |
|
MD5 | 7fbdddefe67b2e17f1fbc8d2e3fe4661 |
|
BLAKE2b-256 | 50b35d833d3ff185752d0977eb994a6654c120d6eb6c50095e609671ebfc7c22 |