simplecharts

commit

354507b952e85a7ddea5889569e1c3ef0cc07006

parent

1fa872f554af86453c42613985aff7b253a56986

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2023-11-05 10:02

convert README to markdown

Diffstat

2 files changed, 31 insertions, 33 deletions

diff --git a/README.rst b/README.md

@@ -1,42 +1,40 @@
    1    -1 Features
    2    -1 ========
   -1     1 # Features
    3     2 
    4     3 -   no external dependencies
    5     4 -   produces clean SVG
    6    -1 -   available charts: grouped columns, stacked columns, lines, stacked areas
   -1     5 -   available charts: grouped columns, stacked columns, lines, stacked
   -1     6     areas
    7     7 
    8    -1 Limitations
    9    -1 ===========
   -1     8 # Limitations
   10     9 
   11    10 -   not interactive
   12    11 -   not configurable
   13    12 -   maximum of 6 colors
   14    13 -   no wrapping for long labels
   15    14 
   16    -1 Usage
   17    -1 =====
   18    -1 
   19    -1 .. code:: python
   20    -1 
   21    -1     from simplecharts import StackedColumnRenderer
   22    -1 
   23    -1     renderer = StackedColumnRenderer()
   24    -1     data = {
   25    -1         'rows': [{
   26    -1             'label': 'Apples',
   27    -1             'values': [3, 2, 5],
   28    -1         }, {
   29    -1             'label': 'Oranges',
   30    -1             'values': [4, 2, 3],
   31    -1         }, {
   32    -1             'label': 'Pears',
   33    -1             'values': [4, 3, 4],
   34    -1         }, {
   35    -1             'label': 'Bananas',
   36    -1             'values': [5, 1, 2],
   37    -1         }],
   38    -1         'legend': ['John', 'Jane', 'Joe'],
   39    -1     }
   40    -1     svg = renderer.render(data)
   41    -1 
   42    -1 .. figure:: https://github.com/xi/simplecharts/blob/master/tests/simple_StackedColumnRenderer.svg
   -1    15 # Usage
   -1    16 
   -1    17 ```python
   -1    18 from simplecharts import StackedColumnRenderer
   -1    19 
   -1    20 renderer = StackedColumnRenderer()
   -1    21 data = {
   -1    22     'rows': [{
   -1    23         'label': 'Apples',
   -1    24         'values': [3, 2, 5],
   -1    25     }, {
   -1    26         'label': 'Oranges',
   -1    27         'values': [4, 2, 3],
   -1    28     }, {
   -1    29         'label': 'Pears',
   -1    30         'values': [4, 3, 4],
   -1    31     }, {
   -1    32         'label': 'Bananas',
   -1    33         'values': [5, 1, 2],
   -1    34     }],
   -1    35     'legend': ['John', 'Jane', 'Joe'],
   -1    36 }
   -1    37 svg = renderer.render(data)
   -1    38 ```
   -1    39 
   -1    40 ![example](https://github.com/xi/simplecharts/blob/master/tests/simple_StackedColumnRenderer.svg)

diff --git a/pyproject.toml b/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
    6     6 name = "simplecharts"
    7     7 version = "0.0.2"
    8     8 description = "SVG charts without dependencies"
    9    -1 readme = "README.rst"
   -1     9 readme = "README.md"
   10    10 license = {text = "MIT"}
   11    11 keywords = ["svg", "charts"]
   12    12 authors = [