https://github.com/mainro/dooble

marble diagram generator from text input
https://github.com/mainro/dooble

generator marble-diagrams reactive-programming reactivex

Last synced: about 2 months ago
JSON representation

marble diagram generator from text input

• Host: GitHub
• URL: https://github.com/mainro/dooble
• Owner: MainRo
• License: mit
• Created: 2019-02-10T22:40:16.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:47:00.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T06:51:38.616Z (about 2 months ago)
• Topics: generator, marble-diagrams, reactive-programming, reactivex
• Language: Python
• Size: 92.8 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
======

dooble

======

.. image:: https://img.shields.io/pypi/v/dooble.svg

        :target: https://pypi.python.org/pypi/dooble

.. image:: https://img.shields.io/travis/MainRo/dooble.svg

        :target: https://travis-ci.org/MainRo/dooble

Dooble is a marble diagram generator from text. It eases the documentation of

ReactiveX standard and custom operators, in a consitent way.

Installation

-------------

.. code:: python

        pip install dooble

A sphinx plugin is also available:

.. code:: python

        pip install sphinxcontrib-dooble

Usage

------

The text grammar allows to easilly define *observables* and *operators*. The map

operator with an input observable and an output observable is described the

following way:

.. code::

        --1--2--3--4-->

        [ map(i: i*2) ]

        --2--4--6--8-->

save this text in a file named *map.txt* and then render it to an image:

.. code:: console

        dooble --input map.txt --output map.png

The generated image looks like this:

.. image:: examples/map.png

*Higher order observables* can also be documented easilly:

.. code::

        --a-b-c---d-e-f-->

        [     window     ]

        --+-------+------>

                  +d-e-f-|

          +a-b-c-|

save this text in a file named *window.txt* and then render it to an image:

.. code:: console

        dooble --input window.txt --output window.png

The generated image looks like this:

.. image:: examples/window.png

For operators that take several observables as input, it is possible to label

them:

.. code::

        --1--2--3--*

                 a-7-8-|

        [   catch(a)   ]

        --1--2--3--7-8-|

save this text in a file named *catch.txt* and then render it to an image:

.. code:: console

        dooble --input catch.txt --output catch.png

The generated image looks like this:

.. image:: examples/catch.png

Full grammar

------------

* Each text line represents either an observable, or an operator

* Observables are defined with dash lines

* If an Observable starts with a letter, this letter is considered as a label

* Each character represent a time span

* Character ``|`` indicates an observable completion

* Character ``*`` indicates an observable error

* Character ``>`` indicates an observable continutation

* The ``+`` character is used to define anchors of higher order observables

* operators start with a ``[`` and end with a ``]``

The full grammar is the following one (in tatsu pseudo ebnf syntax):

.. code::

        @@grammar::dooble

        start = { layer } $ ;

        layer

        =

        | obs:observable

        | op:operator

        ;

        observable = {skipspan}* [prefix] {lifetime}* completion ;

        operator = '[' description ']' ;

        prefix = '+' | label ;

        label = /[a-z]/ ;

        lifetime

        =

        | ts:timespan

        | item:item

        ;

        completion = /[>|*]/ ;

        skipspan = ' ' ;

        timespan = '-' ;

        item = /[a-zA-Z0-9+.,]+/ ;

        description = /[a-zA-Z0-9,:+*() <>_]+/ ;