Skip to main content

Easily create a Saagie Python job from a Jupyter notebook

Project description

# Jupyter Saagie plugin This plugin allows you to easily create a Saagie Python job from a local Jupyter notebook.

## Install In your Jupyter Python environment, run: pip install jupyter-saagie-plugin

## Usage Simply run jupyter notebook as always, you will see a new button in the toolbar. Use it to log in to your account and deploy a job using the code in your notebook. You can update an existing job as well.

For deploying to a Python job, Python 3.5 & 2.7 are supported.

If you want to pre-fill your Saagie root URL (used in the plugin’s login form), you can setup a SAAGIE_ROOT_URL environment variable before you run the notebook.

## Uninstall ` pip uninstall jupyter-saagie-plugin jupyter nbextension uninstall saagie --user `

## Modifying this extension In dev mode, you can use a Docker of Jupyter notebook and install this extension in it. First, run a Jupyter Docker in bash mode:

` docker run -it --rm -p 8888:8888 -v [your_project_path]/jupyter-saagie-plugin/:/jupyter-saagie-plugin/ [--env SAAGIE_ROOT_URL="https://xxx-manager.prod.saagie.io/"] saagie/jupyter-python-nbk:latest /bin/bash ` _(Seting up the SAAGIE_ROOT_URL environment variable is optional)_

Then install the Jupyter extension in your Docker container: ` cd /jupyter-saagie-plugin/ python3 setup.py install cd /notebooks-dir /usr/local/bin/start-notebook.sh --NotebookApp.token='' `

## Build and share In order to build this plugin, run the following command: ` python setup.py sdist ` This will generate a tar.gz archive in the dist directory.

If you want to share it on Pypi, just install [twine](https://pypi.python.org/pypi/twine) and run: ` twine upload dist/jupyter-saagie-plugin-x.x.x.tar.gz `

But first, You can test your Pypi deployment on [TestPypi](https://testpypi.python.org/pypi) test environment. If so, just run: ` twine upload --repository-url https://test.pypi.org/legacy/ dist/jupyter-saagie-plugin-x.x.x.tar.gz `

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

jupyter-saagie-plugin-1.0.1.tar.gz (33.2 kB view details)

Uploaded Source

File details

Details for the file jupyter-saagie-plugin-1.0.1.tar.gz.

File metadata

File hashes

Hashes for jupyter-saagie-plugin-1.0.1.tar.gz
Algorithm Hash digest
SHA256 9d946497cf0612ee6cedd483b737a61d5b3cf8128050dfd840556055829210b9
MD5 b6ec2f78fdc2d065e0929893065d3b2f
BLAKE2b-256 87a422b4d45bdfa2c23ac74f8a5a9ca4dea7e70e1dd60fae1665b8f5044b1778

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page