Skip to main content

CLI to schedule Jupyter Notebook execution with Papermill and Argo

Project description

https://img.shields.io/pypi/v/yason.svg https://img.shields.io/travis/com/ktaletsk/yason.svg Documentation Status Updates

yason: Jupyter Notebook Scheduler for Argo

logo

JupyterHub deployed on Kubernetes allows teams to do data analysis in the browser and efficiently share computational resources. But when it comes to Jupyter Notebooks, it is not easy to run them remotely and non-interactively or schedule them. Fortunately, with Papermill and Argo Workflows it is now possible to do just that. Yason is Python package and CLI for scheduling the remote execution of Jupyter Notebooks.

Features

  • Check the status of all scheduled notebook jobs
  • Schedule a notebook for execution
  • Get resulting notebook after execution
  • Delete scheduled notebook job

Coming soon

  • Including multiple files/folders together with Notebook for execution
  • Integration with Argo events for scheduling

Prerequisites

Yason is intended to run on JupyterLab pods spawned by JupyterHub deployed on Kubernetes. Yason also requires Argo Workflows to be deployed on the same cluster in the namespace argo. S3 bucket is required for intermediate storage of Notebooks before and after their execution.

See more details and instructions in the full documentation https://yason.readthedocs.io

Usage

To use Yason in Python project:

from yason import yason

CLI Tool

To use Yason as CLI tool, type:

yason COMMAND [ARGS]

To see the list of all scheduled Notebooks for your JupyterHub username, type:

yason list

To schedule and execute Notebook immediately, type:

yason run <Notebook Name>.ipynb

To get the resulting Notebook after execution, type:

yason get <Workflow ID> <Destination>

i.e.:

yason get 25fe9753bc854148aac26ff7d97ba128 My_Notebook_result.ipynb

To delete the scheduled Notebook from your list, type:

yason delete <Workflow ID>

i.e.:

yason delete 25fe9753bc854148aac26ff7d97ba128

Name

Yason (or Jason) in Greek mythology is the leader of Argonauts. Yason brings your Jupyter Notebooks on board of Argo (Workflows).

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2019-05-22)

  • First release on PyPI.

Project details


Download files

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

Files for yason, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size yason-0.1.4-py2.py3-none-any.whl (7.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size yason-0.1.4.tar.gz (12.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page