Metadata-Version: 1.1
Name: colomoto-jupyter
Version: 0.2
Summary: CoLoMoTo helper functions for Juypter integration
Home-page: https://github.com/colomoto/colomoto-api
Author: Loïc Paulevé
Author-email: loic.pauleve@ens-cachan.org
License: LGPL v3+/CeCILL-C
Description-Content-Type: UNKNOWN
Description: # CoLoMoTo helper functions for Juypter integration
        
        [![PyPI version](https://badge.fury.io/py/colomoto_jupyter.svg)](https://badge.fury.io/py/colomoto_jupyter)
        
        
        Provides helper functions for integration in the CoLoMoTo Jupyter notebook.
        It currently provides:
        * injection of menus and toolbars
        * interactive file upload
        * formatter for ``networkx`` graphs
        
        See also https://github.com/colomoto/colomoto-docker
        
        
        ## Quick usage guide
        
        
        ```python
        from colomoto_jupyter import IN_IPYHON, jupyter_setup
        
        if IN_IPYTHON:
        
            # menu specification (list of dict), optional
            menu = [
                {"name": "entry 1",
                    "snippet": ["code to be append to the current cell"]},
                "---", # separation
                {"name": "submenu 1",
                    "sub-menu": [
                        {"name": "entry 2",
                            "snippet": ["code example"]},
                    ]}
            ]
        
            # toolbar specification (list of dict), optional
            toolbar = [
                {"name": "Label",
                 "setup": {
                    "icon": "fa-something", # http://fontawesome.io/icons/
                    "help": "tooltip text",
                    "handler": "javascript_function_1"}}
            ]
        
            ## additional javascript functions, optional
            js_api = {
                "javascript_function_1":
                    """
                    function () { alert("plop"); }
                    """,
                "javascript_function_2":
                    """
                    function () { alert("bar"); }
                    """,
            }
        
            jupyter_setup("mymodule",
                label="My module",
                color="blue", # for menu and toolbar
                menu=menu,
                toolbar=toolbar,
                js_api=js_api)
        ```
        
        See
        https://github.com/colomoto/colomoto-api/blob/master/colomoto_jupyter/demo_tool.py for a more complete usage example.
        
        
        
Keywords: jupyter,computational systems biology
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
