Metadata-Version: 2.1
Name: freeplane-tools
Version: 0.0.4
Summary: This package provides some tooling around translating freeplane mindmap files into other useful formats
Home-page: https://github.com/shollingsworth/freeplane_tools
Maintainer: Steven Hollingsworth
Maintainer-email: hollingsworth.stevend@gmail.com
License: MIT
Description: # TOC
        * [Freeplane Tools](#freeplane-tools-)
           * [Installation](#installation-)
           * [License](#license-)
           * [Quickstart](#quickstart-)
              * [Example](#example-)
           * [CLI Commands](#cli-commands-)
           * [Building](#building-)
           * [API](#api-)
        
        
        # Freeplane Tools [&#8593;](#toc)
        If you hate writing Markdown, but love mindmaps (and using [freeplane](https://www.freeplane.org/wiki/index.php/Home) this toolset is for you.
        
        These python programs aim to ease translating a mindmap into various markdown formats.
        
        This document [README.md](./README.md) was made with `mm2github.py` with  [from README.mm](./README.mm) as a source.
        
        Enjoy!
        
        Pull requests welcome. :)
        ## Installation [&#8593;](#toc)
        To install this package from [pypy](https://pypi.org/project/freeplane-tools/) run the following command.
        
        
        ```
        
        pip3 install freeplane_tools
        
        ```
        
        ## License [&#8593;](#toc)
        See: [LICENSE](./LICENSE)
        ## Quickstart [&#8593;](#toc)
        Run the following if you want a quick demo of how this works. Have `freeplane` installed before running this.
        
        
        ```
        
        pip3 install freeplane_tools
        
        mm2template.py mymindmap.mm
        
        freeplane mymindmap.mm
        
        # do your editing in freeplane
        
        mm2github.py -w mymindmap.mm
        
        
        ```
        
        This will create: `mymindmap.md`
        ### Example [&#8593;](#toc)
        Just want to look?
        
        [This](./freeplane_tools/examples/template.mm) mindmap produces the following [markdown](./freeplane_tools/examples/template.md)
        ## CLI Commands [&#8593;](#toc)
        *mm2bitbucket_server.py*
        ```
        usage: mm2bitbucket_server.py [-h] [-w] [-o OUTFILE] mindmap_file
        
        Convert a Freeplane Mindmap to Bitbucket Markdown.
        
        positional arguments:
          mindmap_file          mindmap_file help
        
        optional arguments:
          -h, --help            show this help message and exit
          -w, --write           write markdown file
          -o OUTFILE, --outfile OUTFILE
        
        ```
        ---
        *mm2github.py*
        ```
        usage: mm2github.py [-h] [-w] [-o OUTFILE] mindmap_file
        
        Convert a Freeplane Mindmap to Github Markdown.
        
        positional arguments:
          mindmap_file          mindmap_file help
        
        optional arguments:
          -h, --help            show this help message and exit
          -w, --write           write markdown file
          -o OUTFILE, --outfile OUTFILE
        
        ```
        ---
        *mm2template.py*
        ```
        usage: mm2template.py [-h] dest_file
        
        Copy a Mindmap Template to destination file.
        
        positional arguments:
          dest_file   destination file
        
        optional arguments:
          -h, --help  show this help message and exit
        
        ```
        ---
        ## Building [&#8593;](#toc)
        os / Package prerequisites:
        
        ```
        
        pip3 install twine pdoc3
        
        ```
        
        * Install Locally from master
           * ``` make install_local ```
        * build package
           * ``` make pkg ```
        * documentation only
           * ``` make documentation ```
        ## API [&#8593;](#toc)
        API / Class documentation can be found [here](https://shollingsworth.github.io/freeplane_tools/)
        
Keywords: freeplane,mindmap,markdown
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
