cortx-jupyter 0.1.115

Jupyter Notebook Manager for Cortx

# Cortx Jupyter Integration

### Jupyter Notebook Integration for Cortx Object Storage.

Built for [Seagate Cortx Hackathon 2021](https://seagate-cortx-hackathon.devpost.com/)


No more losing precious work because you forgot to save changes or no more worrying about local filesystem crashes or paying exorbitant subscription fees for Premium features of Hosted Jupyter Notebooks. Cortx Jupyter is here to save you from all these! Cortx Jupyter is an Open Source python package which combines the power of Cortx and Jupyter Notebooks to empower you to store all of your Jupyter Notebooks, Checkpoints and Data Files on Cortx Object Storage instead of Jupyter’s standard filesystem-backed storage.

When you opt to use a plain Jupyter notebook as your development environment, everything is saved in your local machine. If you want your Jupyter notebooks to be accessible to you from anywhere or any device, then Cortx Jupyter Integration is the way to go. All of your Jupyter notebooks, checkpoints and data files are saved in your Cortx Object Storage, so that you can access it from anywhere on the go.

Cortx Jupyter Integration can be used by developers and organizations who want a central repository of Notebooks, Checkpoints and Files. This feature can help multiple developers across an organization to collaborate with each other. Cortx Jupyter Integration integration periodically saves updates to your notebook as checkpoints to Cortx Object Storage so that you can either revert to a previous checkpoint or your colleague can continue working on the Jupyter Notebook from where you left.

You don’t have to worry about having notebooks and data saved in different places. With Cortx Jupyter, you can have them together on CORTX: World’s Only 100% Open Source Mass-Capacity Optimized Object Store. Now, you can concentrate on Machine Learning while Cortx Jupyter does the boring work of saving and tracking your work.

## Features

• Seamlessly Save notebooks, checkpoints, data files to Cortx.

• Save multiple checkpoints for each notebooks to Cortx.

• Checkpoints are saved to Cortx, under the key <file_name>/.checkpoints/.

• Restore from any of the previous checkpoints.

• Multiple checkpoints are saved.

• Already, have notebooks on S3? No worries, Cortx Jupyter integration can help you can switch easily from S3 to Cortx Open Source object storage.

• Read large amount of data to your notebook directly from Cortx High Performance Object Storage for Machine Learning tasks.

• Delete Notebooks, Files that you don’t need from Cortx.

• Renaming Notebook name automatically updates Notebook and Checkpoint names on Cortx.

• Jupyter Notebook is not blocked when requests are made to Cortx as everything has been implemented asynchronously.

• View, Upload and Download any types of files that are in Cortx using Jupyter

## Prerequisites

### Setup Cortx

Use the instructions at the following link to setup CORTX:

https://github.com/Seagate/cortx/blob/main/QUICK_START.md

## Setup Instructions

### 1. Installation

Install the Cortx Jupyter python package using the following command:

pip install cortx-jupyter

You can find the package on [pypi.org](https://pypi.org/project/cortx-jupyter/)

### 2. Add Jupyter Config

Configure Jupyter to use Cortx Jupyter for its storage backend. This can be done by modifying your notebook config file. On a Unix-like system, your Jupyter Notebook config will be located at ~/.jupyter/jupyter_notebook_config.py

NOTE: If you can’t find this config file on your machine, you can create this file using the following command in terminal:

jupyter notebook –generate-config

Now, edit the ~/.jupyter/jupyter_notebook_config.py file.

NOTE: Please remember to replace credentials(access_key_id , secret_access_key) and endpoint_url with credentials of your Cortx environment.

import cortx_jupyter from cortx_jupyter import CortxJupyter, CortxAuthenticator

c = get_config()

c.NotebookApp.contents_manager_class = CortxJupyter c.CortxJupyter.authentication_class = CortxAuthenticator

c.CortxAuthenticator.access_key_id = “YOUR_ACCESS_KEY_ID” c.CortxAuthenticator.secret_access_key = “YOUR_SECRET_ACCESS_KEY” c.CortxJupyter.endpoint_url = “http://uvo1ettj69aisne19p9.vm.cld.sr” c.CortxJupyter.bucket_name = “testbucket” c.CortxJupyter.prefix = “notebooks/test/”

Following Configuration options are available on CortxAuthenticator:

access_key_id (required) secret_access_key (required)

You can get these credentials

Following Configuration options are available on CortxJupyter:

endpoint_url`*(required)* - Endpoint URL of your Cortx instance. Example: ```http://uvo1ettj69aisne19p9.vm.cld.sr``

bucket_name`*(required)* - Cortx Bucket Name where you want to store your notebook. Example: ```testbucket``

prefix`*(required)* - Path in the bucket where you want to store your notebook. Example: ```notebooks/test/``

## Architecture


## How we built it?

• Cortx

• S3 API

• Python

• Python Package Index

• Jupyter

• boto3

• tornado

## Demo Video

Watch the video to learn more about the project.

## Contributors:

[Sumanth Reddy Muni](https://www.linkedin.com/in/sumanthmuni/) [Priyadarshini Murugan](https://www.linkedin.com/in/priya-murugan/)