python-zeppelin/README.md

Python Zeppelin

Requirements

• Python 3.* (Tested on Python 3.6 -- may work on other versions)
• Cairo: python-zeppelin relies on CairoSVG to convert SVG to PNG. Please refer to the CairoSVG documentation for installation instructions.

Installation

pip install python-zeppelin

Usage

Converter

To convert a Zeppelin .json file into Markdown (.md), run zeppelin-convert -i <<INPUT>> -o <<OUTPUT>> in the main directory.

• <<INPUT>> is the file name. This is a required field.
• <<OUTPUT>> is the output file name. This is optional. If this is not provided, the output file name will be called knowledge.md and it will be stored in the current directory. You can also provide a path before the filename to specify a location to save the file path/to/file/filename.

If there are png outputs, they will be stored under /images in the same location as the output file.

Executor

To execute a Zeppelin notebook in command line, run zeppelin-execute -i <<INPUT>> -o <<OUTPUT>> -u <<URL>> in the main directory.

• <<INPUT>> is the file name. This is a required field.
• <<OUTPUT>> is the path where you want to save the executed json. This is optional. If this is not provided, the output file will be saved to the current directory. The file name is note.json.
• <<URL>> is the zeppelin url. This is optional. The default is localhost:8890.

Testing

To execute the tests under /tests, run pytest -v.