Skip to content

Commit 26132b5

Browse files
AnnMarieWAnnMarieW
authored
Merge pull request #266 from AnnMarieW/update-readme
Update readme
2 parents 7ca4835 + 6e12b36 commit 26132b5

File tree

3 files changed

+137
-46
lines changed

3 files changed

+137
-46
lines changed

‎CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
# Dash AG Grid Contributing Guide
3+
4+
Dash AG Grid welcomes community contributions!
5+
6+
If you have identified a bug or have an idea for a new feature, it's best to start with a GitHub issue. First look at existing issues at https://github.com/plotly/dash-ag-grid/issues to make sure this is not a duplicate. Then create a new issue. Bug reports should be accompanied by a small example app that someone else can copy and run to reproduce the problem.
7+
8+
If you have questions, please ask on the [Dash Community Forum](https://community.plotly.com/). rather than using GitHub issues.
9+
10+
11+
### Developing in this repo
12+
13+
Make sure you have Dash installed with dev and testing extras:
14+
```
15+
pip install dash[dev,testing]
16+
```
17+
Build the component (from the root of this repo):
18+
```
19+
npm i
20+
npm run build
21+
```
22+
Now install the component in development mode:
23+
```
24+
$ pip install -e .
25+
```
26+
In development mode, Python uses the files in this directory when you import the package. So you can write a testing app in another folder, and whenever you change some code and rebuild the component here it will update in your testing app.
27+
28+
### Create a production build
29+
30+
Create source and wheel distributions in the generated `dist/` folder, after emptying out any previous builds:
31+
```
32+
rm -rf dist build
33+
python setup.py sdist bdist_wheel
34+
```
35+
See [PyPA](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project)
36+
for more information.
37+
Then use [`twine`](https://pypi.org/project/twine/) to upload these to PyPI:
38+
```
39+
twine upload dist/*
40+
```
41+
We also publish the JavaScript build to NPM, so `unpkg` has the bundles if users set `serve_locally=False`. First make a test of the NPM package, verify that its contents are reasonable:
42+
```
43+
npm pack
44+
```
45+
Then publish:
46+
```
47+
npm publish
48+
```

‎README.md

Lines changed: 82 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,103 @@
1-
# Dash AG Grid
1+
# Dash AG Grid [![PyPi Version](https://img.shields.io/pypi/v/dash-ag-grid.svg)](https://pypi.org/project/dash-ag-grid/)
22

33
Dash AG Grid is a Dash component wrapper for the AG Grid JavaScript package, enabling you to display AG Grid components natively in your Dash app.
44

55
The underlying AG Grid JavaScript package is a third-party software component developed by [AG Grid Ltd](http://www.ag-grid.com/). Many features are available for free in the AG Grid [Community version](https://github.com/ag-grid/ag-grid). Some features require a paid subscription to the AG Grid Enterprise version ([more info available here](https://www.ag-grid.com/license-pricing.php)). Both the community and enterprise versions are included in this component, but the enterprise features require you to provide a valid AG Grid license key. The demos which use Enterprise features are clearly marked.
66

77

8-
## v2.0.0 Release
8+
### Documentation
9+
Please see the [Plotly Dash AG Grid Documentation](https://dash.plotly.com/dash-ag-grid).
910

10-
If you have tried v2.0.0 alpha releases, release candidates, or our v1.x enterprise package, please see our [Migration Guide](https://dash.plotly.com/dash-ag-grid/migration-guide) (previously hosted [here](https://dashaggrid.pythonanywhere.com/getting-started/migration-guide)).
11+
### Quick Start
1112

13+
`pip install dash-ag-grid`
1214

13-
### Getting Started
15+
This basic grid has the following features enabled by default:
16+
- Alpine theme
17+
- Sort
18+
- Resize, reorder and pin columns
19+
- Boolean values rendered as check boxes
20+
- Row animation on sort
1421

15-
`pip install dash-ag-grid`
22+
```python
1623

24+
import dash_ag_grid as dag
25+
from dash import Dash
26+
import pandas as pd
1727

18-
### Documentation
19-
Please see the [Dash Documentation](https://dash.plotly.com/dash-ag-grid).
28+
app = Dash()
2029

21-
## Contributing
30+
df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/ag-grid/space-mission-data.csv")
2231

23-
Dash AG Grid welcomes community contributions!
32+
app.layout = dag.AgGrid(
33+
rowData=df.to_dict("records"),
34+
columnDefs=[{"field": i} for i in df.columns],
35+
)
2436

25-
If you have identified a bug or have an idea for a new feature, it's best to start with a GitHub issue. First look at existing issues at https://github.com/plotly/dash-ag-grid/issues to make sure this is not a duplicate. Then create a new issue. Bug reports should be accompanied by a small example app that someone else can copy and run to reproduce the problem.
37+
app.run(debug=True)
38+
```
2639

27-
The docs are under development as well. There are many examples in the official AG Grid docs that have not been included here yet. Please open an issue or do pull requests for edits or to add examples. Or post your question, comments or demo apps on the [Dash Community Forum](https://community.plotly.com/).
40+
<img src="https://github.com/AnnMarieW/dash-ag-grid-examples/assets/72614349/74fe86e1-eb54-4dec-915f-d692f2c8cead" width="1000"/>
2841

2942

30-
### Developing in this repo
43+
### AG Grid Community Features
44+
Here are a few of the AG Grid Community features available:
3145

32-
Make sure you have Dash installed with dev and testing extras:
33-
```
34-
pip install dash[dev,testing]
35-
```
36-
Build the component (from the root of this repo):
37-
```
38-
npm i
39-
npm run build
40-
```
41-
Now install the component in development mode:
42-
```
43-
$ pip install -e .
44-
```
45-
In development mode, Python uses the files in this directory when you import the package. So you can write a testing app in another folder, and whenever you change some code and rebuild the component here it will update in your testing app.
46+
- Column Interactions (resize, reorder, and pin columns)
47+
- Column Spanning
48+
- Column Grouping
49+
- Pagination
50+
- Sorting
51+
- Row Selection
52+
- Row Reordering
53+
- Row Spanning
54+
- Pinned Rows
55+
- Full Width Rows
4656

47-
### Create a production build
57+
- Cell data types with automatic type inference
58+
- Custom Filtering
59+
- Cell Editing
60+
61+
- Provided components including number editors, date picker, select editor, text editor, large text editor
62+
- Custom Components in cells - add your own components such as buttons, graphs, indicators, markdown and more
63+
- Tooltips in cells and headers
64+
65+
- Provided themes with light/dark versions
66+
- Customizable themes
67+
- Figma Design System to design and customize themes
68+
69+
- Format Cell Data
70+
- Conditional formatting
71+
72+
- Data Export to CSV
73+
- Keyboard Navigation
74+
- Accessibility support
75+
- Localization
76+
77+
78+
79+
### AG Grid Enterprise features
80+
Here are a few of the features available in AG Grid Enterprise. See the AG Grid docs for more information.
81+
82+
- Grouping / Aggregation
83+
- Advanced Filtering
84+
- Records Lazy Loading
85+
- Server-Side Records Operations
86+
- Hierarchical Data Support & Tree View
87+
- Data Export to Excel
88+
- Excel-like Pivoting
89+
- Copy / Paste
90+
- Sparklines
91+
92+
### See a [live demo](https://www.ag-grid.com/example/) of AG Grid Community and Enterprise Features
93+
94+
---------
95+
96+
97+
98+
<img src="https://github.com/AnnMarieW/dash-ag-grid-examples/assets/72614349/0c7319e4-0ebd-437a-bbdc-1091ec7ae325" width="1000"/>
99+
100+
### Contributing
101+
102+
We welcome contributions to `dash-ag-grid`. Please see our [contributing guide](https://github.com/plotly/dash-ag-grid/blob/main/CONTRIBUTING.md) for more information.
48103

49-
Create source and wheel distributions in the generated `dist/` folder, after emptying out any previous builds:
50-
```
51-
rm -rf dist build
52-
python setup.py sdist bdist_wheel
53-
```
54-
See [PyPA](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project)
55-
for more information.
56-
Then use [`twine`](https://pypi.org/project/twine/) to upload these to PyPI:
57-
```
58-
twine upload dist/*
59-
```
60-
We also publish the JavaScript build to NPM, so `unpkg` has the bundles if users set `serve_locally=False`. First make a test of the NPM package, verify that its contents are reasonable:
61-
```
62-
npm pack
63-
```
64-
Then publish:
65-
```
66-
npm publish
67-
```

‎docs/app.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@
7676
app._callback_list.extend(new_callback_list)
7777

7878

79+
alert = dbc.Alert([
80+
html.H1("Great News! Dash AG Grid docs are now available at:", className="p-5" ),
81+
html.H3(" https://dash.plotly.com/dash-ag-grid"),
82+
html.H5("Please use the official dash-docs as this site is no longer being updated. ")
83+
], className="text-center", dismissable=True )
84+
85+
7986
app.layout = dbc.Container(
8087
[
8188
dbc.Row(dbc.Col(alert, className="mx-auto")),

0 commit comments

Comments
 (0)