Metadata-Version: 2.1
Name: jp-flowchartjs
Version: 0.0.1
Summary: IPython/Jupyter notebook magic for generating JS flowcharts.
Home-page: https://github.com/innovationOUtside/flowchart_js_jp_proxy_widget
Author: Tony Hirst
Author-email: tony.hirst@open.ac.uk
License: MIT License
Description: # flowchart_js_jp_proxy_widget
        [jp_proxy_widget](https://github.com/AaronWatters/jp_proxy_widget) class wrapper for [flowchart.js](https://flowchart.js.org/)
        
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/innovationOUtside/flowchart_js_jp_proxy_widget/master?filepath=demo.ipynb)
        
        
        ![](flowchart_js_magic.png)
        
        We can also script the production of the flowchart:
        
        ```python
        from jp_flowchartjs.jp_flowchartjs import FlowchartWidget
        
        fcode='''
        st=>start: Start
        e=>end: End
        op1=>operation: Generate
        op2=>parallel: Evaluate
        st(right)->op1(right)->op2
        op2(path1, top)->op1
        op2(path2, right)->e
        '''
        
        testEmbed = FlowchartWidget()
        testEmbed.charter(fcode)
        testEmbed
        ```
        
        - return SVG embed: `testEmbed.embed_svg()`
        - return SVG data: `testEmbed.get_svg()`
        - return PNG embed: `testEmbed.embed_png()`
        - return PNG raw: `testEmbed.getpng()`
        - oneliner return SVG: `FlowchartWidget().charter(fcode, embed=True)`
        
        We can also define a really simple magic:
        
        ```python
        from IPython.core.magic import register_cell_magic
        
        @register_cell_magic
        def flowchart_magic(line, cell):
            "Send code to simulator."
            return FlowchartWidget().charter(cell, embed=True)
         ```
        
        and then call as:
        
        ```
        %%flowchart_magic
        
        st=>start: Start
        e=>end: End
        op1=>operation: Generate
        op2=>parallel: Evaluate
        st(right)->op1(right)->op2
        op2(path1, top)->op1
        op2(path2, right)->e
        ```
        
        
        If you `import jp_flowchartjs.jp_flowchartjs` the magic will be available.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Education
Classifier: License :: Free For Educational Use
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering :: Visualization
Description-Content-Type: text/markdown
