github

biancasubion / jupyshare

  • воскресенье, 9 июля 2017 г. в 03:13:52
https://github.com/biancasubion/jupyshare




JupyShare

alt text alt text

JupyShare lets you release your notebook to the cloud and gives you a public endpoint for it through ngrok. (Ngrok lets you expose localhost directly to the internet)

Motivation

JupyShare is perfect for two things

  1. For freeing you up from the huge hassle of trying to debug jupyter notebooks with friends by taking screenshots or copy pasting
  2. For showing something cool to a friend without having to tell them to download your masterpiece

ToDo

  1. done in v. 1.0.8 Print statement when an ngrok process is killed
  2. Try to see if there's a way to automatically kill the ngrok process once you close a notebook
  3. Add a TTL for each ngrok process

Security

Ngrok provides a tunnel to your notebook so you definitely do not want to share the complete link (with the token and everything) with the world because any random person would pretty much have access to your own localhost and start running code on jupyter. To kill the connection to your notebook just run jupyshare kill.

[edit] you can close your notebook, but it will only kill the ngrok process when you either run jupyshare kill or jupyshare show immediately after (as of 1.0.7 I didn't write a print statement that it killed the process. 1.0.8 fixes this issue)

Prerequisites

The only thing necessary for JupyShare is ngrok.

brew cask install ngrok

Installing

pip install jupyshare

Commands

jupyshare release

jupyshare kill

jupyshare show

jupyshare --h or --help

jupyshare --browser BROWSER

License

This project is licensed under the MIT License - see the LICENSE.md file for details