Giter Club home page Giter Club logo

jupyshare's Introduction

JupyShare

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. This comes with risks. Please read security section for more info.)

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 (They have full access to your notebook and can save, edit, etc.)
  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 prints it out)

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

jupyshare's People

Contributors

beacoding avatar amitness avatar

Watchers

James Cloos avatar directorscut82 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.