Metadata-Version: 2.0
Name: brain-dump
Version: 1.1.2
Summary: Tools to generate mindmaps compatible from markdown-like text files, either as PNG with graphviz or as wisemapping-compatible XMLs
Home-page: http://github.com/Lucas-C/brain_dump
Author: Lucas Cimon
Author-email: lucas.cimon+pypi@@gmail.com
License: GPL-3.0
Description-Content-Type: UNKNOWN
Keywords: mindmap wisemapping graph markdown graphviz parser
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Artistic Software
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Text Processing :: Markup
Requires-Dist: pydot
Requires-Dist: pyparsing

|pypi_version_img| |pypi_license_img| |travis_build_status|

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](https://www.twilio.com) webhook that can receive updates for such markdown-like mindmap files, stored in `git`.

For more information, I wrote some [blog posts](https://chezsoi.org/lucas/blog/tag/mindmap/) explaining the role of those scripts.


Table of Contents
=================

.. contents::


Usage
=====

::

    wisemapping_md2xml examples/welcome.md > welcome.xml


::

    graphviz_md2png examples/seasons.md


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/brain_dump
        exec >> upstart-stdout.log
        exec 2>> upstart-stderr.log
        date
        LANG=fr_FR.UTF-8 HOME=$PWD pew-in brain_dump uwsgi --buffer-size 8000 --http :80 --manage-script-name --mount /webhook=brain_dump/twilio_webhook_gitdb_app.py
    end script


Changelog
=========

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


Contributing
============

::

    pip install -r dev-requirements
    pre-commit install

The 2nd command install the `pre-commit hooks <http://pre-commit.com>`__

To only execute a single unit test:

::

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


.. |pypi_version_img| image:: https://img.shields.io/pypi/v/brain_dump.svg?style=flat
   :target: https://pypi.python.org/pypi/brain_dump
.. |pypi_license_img| image:: https://img.shields.io/pypi/l/brain_dump.svg?style=flat
   :target: https://pypi.python.org/pypi/brain_dump
.. |travis_build_status| image:: https://travis-ci.org/Lucas-C/brain_dump.svg?branch=master
    :target: https://travis-ci.org/Lucas-C/brain_dump


