Skip to content

Commit 022a545

Browse files
committed
docs update
1 parent 3306050 commit 022a545

File tree

4 files changed

+110
-4
lines changed

4 files changed

+110
-4
lines changed

CHANGES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Version 0.0.16 (from 2024/11/12)
2+
3+
Initial, still experimental version.

docs/about.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
## Changes
2+
3+
You can find the complete Chartlets changelog
4+
[here](https://github.com/bcdev/chartlets/blob/main/CHANGES.md).
5+
6+
## Reporting
7+
8+
If you have suggestions, ideas, feature requests, or if you have identified
9+
a malfunction or error, then please
10+
[post an issue](https://github.com/bcdev/chartlets/issues).
11+
12+
## Contributions
13+
14+
The Chartlets project welcomes contributions of any form
15+
as long as you respect our
16+
[code of conduct](https://github.com/bcdev/chartlets/blob/main/CODE_OF_CONDUCT.md)
17+
and follow our
18+
[contribution guide](https://github.com/bcdev/chartlets/blob/main/CONTRIBUTING.md).
19+
20+
If you'd like to submit code or documentation changes, we ask you to provide a
21+
pull request (PR)
22+
[here](https://github.com/bcdev/chartlets/pulls).
23+
For code and configuration changes, your PR must be linked to a
24+
corresponding issue.
25+
26+
## Development
27+
28+
To set up the Python development environment, with repository root as
29+
current working directory:
30+
31+
```bash
32+
cd chartlets.py
33+
pip install .[dev,doc]
34+
```
35+
36+
### Testing and Coverage
37+
38+
Chartlets uses [pytest](https://docs.pytest.org/) for unit-level testing
39+
and coverage analysis for its Python code.
40+
41+
```bash
42+
cd chartlets.py
43+
pytest --cov=chartlets tests
44+
```
45+
46+
### Coding Style
47+
48+
Chartlets' Python code is formatted by [black](https://black.readthedocs.io/).
49+
50+
```bash
51+
cd chartlets.py
52+
black .
53+
```
54+
55+
Chartlets' TypeScript code is formatted by
56+
[prettier](https://prettier.io/).
57+
58+
```bash
59+
cd chartlets.js
60+
prettier .
61+
```
62+
63+
### Documentation
64+
65+
Chartlets' documentation is built using the [mkdocs](https://www.mkdocs.org/) tool.
66+
67+
```bash
68+
cd chartlets.py
69+
pip install .[doc]
70+
cd ..
71+
```
72+
73+
With repository root as current working directory:
74+
75+
```bash
76+
# Write
77+
mkdocs serve
78+
79+
# Publish
80+
mkdocs build
81+
mkdocs gh-deploy
82+
```
83+
84+
## License
85+
86+
Chartlets is open source made available under the terms and conditions of the
87+
[MIT License](https://github.com/bcdev/chartlets/blob/main/LICENSE).
88+
89+
Copyright © 2024 Brockmann Consult Development

docs/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ Chartlets is a software framework that allows websites developed with
44
React to be extended by server-side widgets programmed in Python or other
55
programming languages.
66

7+
It comprises a
8+
[Python backend package](https://github.com/bcdev/chartlets/tree/main/chartlets.py)
9+
and a
10+
[JavaScript/React frontend package](https://github.com/bcdev/chartlets/tree/main/chartlets.js).
11+
12+
## Features
13+
14+
- Enhance your React web application by UI-contributions programmed in Python
15+
- Enhance your (Python) web API to serve server-side UI-contributions.
16+
- Uses [Material UI](https://mui.com/material-ui/) components and
17+
[Vega-Lite](https://vega.github.io/vega-lite/) charts.
18+
719
## How it works
820

921
Users write the widgets in, e.g. Python, and a REST server implements three

docs/usage.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
The Chartlets framework has two types of users.
1+
The Chartlets framework has two types of users:
22

3-
- **Application contributors** develop new contributions for a specific web application.
4-
- **Application providers** develop the web application and the service that allows
5-
for server-side UI contributions.
3+
- **Application contributors** develop new contributions
4+
for a specific web application that is powered by Chartlets.
5+
- **Application providers** develop the web application
6+
and the service that allows for server-side UI contributions
7+
using Chartlets.
68

79

810
## Application contributor guide

0 commit comments

Comments
 (0)