Marbles diagram generator
Homepage Repository PyPI Python
This is yet another marble diagram generator for documenting Reactive Extensions sources and operators.
.
characters at the beginning of a timelineThe recommended installation is to get it installed from PyPI repository:
pip3 install rxmarbles
The marblesgen
executable will become available from the command prompt.
You can run the generator without installation, from the source code tree, e.g:
python3 -m rxmarbles --help
A simple text file (foo.txt) with a marble diagram can look like this:
marble foo_example
{
source a: +--A-B--C-#
operator foo: +--1-2--3-|
}
To generate SVG image out of it, you can run:
marblesgen foo.txt
This will produce the following diagram:
To run this marbles diagram generator, you need Python 2.7.x or 3.x with pyparsing
module installed.
The generator's code is fairly platform agnostic and can be used on Linux, Window, Macs and possible other platforms that have proper version of Python installed.
All unit tests for the generator are located in tests
sub-directory. They can be executed from top-level project dir with:
python3 -m unittest discover tests/
Available under MIT license.