CoLoMoTo helper functions for Juypter integration
Project description
# CoLoMoTo helper functions for Juypter integration
[](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.
[](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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
colomoto_jupyter-0.2.tar.gz
(7.2 kB
view details)
File details
Details for the file colomoto_jupyter-0.2.tar.gz.
File metadata
- Download URL: colomoto_jupyter-0.2.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 05895b747bed4cadea54d28d804ba62c4d4773d69f02a687ee81c17a6cce8608 |
|
| MD5 | e0876ad98ec5bf8effc874c1245ba260 |
|
| BLAKE2b-256 | bed9dfb0e271eab5db2e9df6c9ec1f66341efd3cd4109aec3e9e5b009d006607 |
