Skip to main content

Publish jupyter notebooks from the command line.

Project description

NbHub 💫

Build Status Coverage Status PyPI version shields.io Supported Python versions PyPI downloads GitHub license made with: Vim Code style: black

A command-line application for sharing jupyter notebooks to the web.

Simple, minimal, hacky.

This is alpha! Check the roadmap and don't blow up my server.

Installation

NbHub requires pyhton 3.6 or newer.

$ pip install nbhub

I actually recommend you use pipx for installing CLI tools.

Usage

Once installed, simply run:

$ nbhub my_cool_notebook.ipynb

After a couple of prompts you will receive a link like this one.

Contributing

Note: If you want to develop new features and not sure where to start, just email me.

Start by forking this repo.

Install the development dependencies (you probably want to do this in a virtual environment):

 $ pip install -r requirements-dev.txt

Make sure the tests run:

 $ pytest

Bugs and other issues should be reported right here.

Roadmap

  • Open source the web server.
  • Date limit on notebooks to be destroyed.
  • Ability to set password on link creation for private notebooks.
  • Improvements to CLI like only accepting notebook format.
  • Web server improvements (auto clean ups, encryption, etc.)

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

nbhub-20.4b2.tar.gz (3.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page