lucas-c/brain_dump

Tools to generate mindmaps compatible from markdown-like text files, either as PNG with graphviz or as wisemapping-compatible XMLs

Tools to generate mindmaps compatible from markdown-like text files, either as PNG with graphviz or as wisemapping-compatible XMLs.

A viewer for those can be found here: https://github.com/Lucas-C/wisemapping-mindmap-viewer

Also include a Twilio webhook that can receive updates for such markdown-like mindmap files, stored in git.

For more information, I wrote some blog posts explaining the role of those scripts.

Usage

Converting a Markdown indented mind map to wisemapping-compatible XML:

wisemapping_md2xml examples/welcome.md > welcome.xml

Converting a Markdown indented mind map to a Graphviz graph:

graphviz_md2png examples/seasons.md

Twilio web hook deployment

upstart job using pew & uwsgi: /etc/init/brain_dump.conf

start on startup

script
    set -o errexit -o nounset -o xtrace
    cd /path/to/git/dir
    exec >> upstart-stdout.log
    exec 2>> upstart-stderr.log
    date
    APP_SCRIPT=$(dirname $(pew-in brain_dump python -c 'import brain_dump; print(brain_dump.__file__)'))/twilio_webhook_gitdb_app.py
    LANG=fr_FR.UTF-8 pew-in brain_dump uwsgi --buffer-size 8000 --http :8087 --manage-script-name --mount /webhook=$APP_SCRIPT
end script

systemd job using pew with a virtual env named brain_dump & uwsgi: /etc/systemd/system/brain_dump.service

[Unit]
Description=brain_dump

[Service]
WorkingDirectory=/root/brain_dump
Environment=LANG=fr_FR.UTF-8
ExecStart=/usr/local/bin/pew in brain_dump uwsgi --need-app --buffer-size 8000 --http :8087 --manage-script-name --pythonpath=
/root/.local/share/virtualenvs/brain_dump/lib/python3.6/site-packages/brain_dump --mount /webhook=twilio_webhook_gitdb_app:application                                                                                                                      Restart=always

Changelog

https://github.com/Lucas-C/brain_dump/blob/master/CHANGELOG.md

Contributing

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
$HOME/.poetry/bin/poetry install
pre-commit install

The 2nd command install the pre-commit hooks

To only execute a single unit test:

py.test -k 'test_topic_from_line[toto-expected_topic0]'

brain_dump's Issues

twilio_webhook_gitdb_app.py execution time frequently gets over max twilio timeout of 1500ms

This is very probably due to git commands long execution time.

And btw git pull shouldn't be done in db_put but in db_get !
-> https://github.com/Lucas-C/brain_dump/blob/master/brain_dump/twilio_webhook_gitdb_app.py#L116

Feature request : support for Markdown style parsing in graphviz_md2png

This should be doable by:

• using parsers.pseudo_markdown.LineGrammar in graphviz.create_mindmap
• converting the is_bold / is_italic / is_striked into graphviz attributes : https://www.graphviz.org/doc/info/attrs.html
• we could also optionnaly support wisemapping attrs format for fontStyle color / bgColor

ModuleNotFoundError: No module named 'brain_dump.cli'

Reported to me by email:

i used pip to install your brain_dump package and when i issued the command it show something like this

$ graphviz_md2png welcome.md
Traceback (most recent call last):
  File "/home/j/.local/bin/graphviz_md2png", line 7, in <module>
    from brain_dump.cli.graphviz_md2png import main
ModuleNotFoundError: No module named 'brain_dump.cli'
j@culsky8gssd:~/desktop/t$ which graphviz_md2png
/home/j/.local/bin/graphviz_md2png