notebook - Meltano Hub

Jupyter Notebook

notebook (matatika variant)

Jupyter Notebook runner and converter

The notebook utility is a Jupyter Notebook runner and converter.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the notebook utility to your project using
```
meltano add
```
:

meltano add utility notebook

Configure the notebook settings using

meltano config

meltano config notebook set --interactive

Next steps

If you run into any issues, learn how to get help.

Capabilities

This plugin currently has no capabilities defined. If you know the capabilities required by this plugin, please contribute!

Settings

The notebook settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

requirements_path
path
format
config

You can also list these settings using

meltano config

with the list subcommand:

meltano config notebook list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Requirements path (requirements_path)

Environment variable: NOTEBOOK_REQUIREMENTS_PATH

The path to a requirements.txt file containing dependencies for a notebook.

Configure this setting directly using the following Meltano command:

meltano config notebook set requirements_path [value]

Path (path)

Environment variable: NOTEBOOK_PATH

The path to a notebook .ipynb file or directory of notebook files.

Configure this setting directly using the following Meltano command:

meltano config notebook set path [value]

Format (format)

Environment variable: NOTEBOOK_FORMAT

The target format to convert the notebook to.

More information on supported formats

Configure this setting directly using the following Meltano command:

meltano config notebook set format [value]

Configuration (config)

Environment variable: NOTEBOOK_CONFIG
Default Value: ""

Configuration for the nbconvert exporter specified by format as a preset or raw JSON string.

More information on configuration and available presets

Configure this setting directly using the following Meltano command:

meltano config notebook set config [value]

Commands

The notebook utility supports the following commands that can be used with

meltano invoke

convert

Equivalent to: convert $NOTEBOOK_PATH -f $NOTEBOOK_FORMAT -c $NOTEBOOK_CONFIG

Convert a notebook to another format.

meltano invoke notebook:convert [args...]

install

Equivalent to: install $NOTEBOOK_REQUIREMENTS_PATH

Install the dependencies of a notebook to the plugin's Meltano-managed virtual environment (usually `.meltano/utilities/notebook/venv/`).

meltano invoke notebook:install [args...]

run

Equivalent to: run $NOTEBOOK_PATH

Run a notebook.

meltano invoke notebook:run [args...]

run-convert

Equivalent to: run $NOTEBOOK_PATH -f $NOTEBOOK_FORMAT -c $NOTEBOOK_CONFIG

Run and convert a notebook.

meltano invoke notebook:run-convert [args...]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the notebook utility to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add utility notebook

Maintenance Status

Repo

https://github.com/Matatika/utility-notebook

Maintainer

Meltano Stats

Keywords