Skip to main content

NeNo (Network Notebooks) is a tool that allows you manage and trigger your Jupyter notebooks remotely over the network using HTTP.

Project description

NeNo

NeNo (Network Notebooks) is a server and CLI utility that allows you to deploy your jupyter notebooks and trigger their execution by calling an API endpoint. You can then use the CLI to view the execution history and inspect the outputs. Great for scheduled tasks and prototyping APIs.

Installation

If you want just the CLI utility, you can install it with pip:

pip install neno

Then you can start the utility with python -m neno. For convenience, you can create an alias in your shell configuration:

alias neno="python -m neno"

If you want to run the neno server locally, you need to install some optional dependencies:

pip install "neno[server]"

Launching the server

To start the server, first create a config.yaml file:

host: "localhost"
port: 5000
backends:
  # For this simple example, we will use the filesystem to store the data and configuration
  dataBackend:
    filesystem:
      path: "backend/data"
  configBackend:
    filesystem:
      path: "backend/config"

Then you can start the server with:

neno serve --config-file config.yaml

Usage

If your server runs somewhere other than localhost:5000, point the NENO_SERVER_URL environment variable to the correct URL:

export NENO_SERVER_URL=http://localhost:5001

You can then use the CLI to interact with the server:

# Upload a notebook as a new endpoint. The endpoint will be available at $NENO_SERVER_URL/api/gen-report. We can also use the `--file` option as many times as we want to upload additional files that the notebook needs.
neno add endpoint gen-report --notebook create-report.ipynb --file credentials.json --keep-runs=always

# List all the endpoints
neno get endpoints

# List all endpoints and print a curl command for triggering each one of them
neno get endpoints --show-curl

# List recent executions of the `gen-report` endpoint. By default, it will show the last 10 executions.
neno get runs gen-report

# List last 50 executions of the `gen-report` endpoint
neno get runs gen-report --limit 50

# Download the output (output notebook, any additional files) of the execution of `gen-report` with ID 12345
neno fetch run gen-report 12345

# Download the output of run 12345 and open it in a local jupyterlab instance (jupyterlab must be installed: `pip install jupyterlab`)
neno fetch run gen-report 12345 --inspect

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neno-0.2.0.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

neno-0.2.0-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file neno-0.2.0.tar.gz.

File metadata

  • Download URL: neno-0.2.0.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for neno-0.2.0.tar.gz
Algorithm Hash digest
SHA256 78de29494c2f52684dc456009f3378b262aea6eb40f79f14612ce41c125da413
MD5 3b34e9afc74e38a2ec9fc435c54e1945
BLAKE2b-256 97d4daa8e26ff67d99ba3a6c1da435ea821200bc56001751549a8d2916bfdfe8

See more details on using hashes here.

File details

Details for the file neno-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: neno-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for neno-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48d7295a44574878a11a0e3faa1b704da4db185f637053fe00577395024a9df9
MD5 c231006786c72f794fa56a68a3569911
BLAKE2b-256 94b294f64c13a64e6e9db0f3d472b5ab52c0a8f5ebd4093d5975c9610fa3efac

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page