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 details)

Uploaded Source

File details

Details for the file nbhub-20.4b2.tar.gz.

File metadata

  • Download URL: nbhub-20.4b2.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.1

File hashes

Hashes for nbhub-20.4b2.tar.gz
Algorithm Hash digest
SHA256 2fc1fdb1194c85d7546334c6c2e5fb9b4ba22c6230c99b3c8e032911bd4b1470
MD5 bc96b8396a7b67e12ec44abe41153138
BLAKE2b-256 e77d10f74e5b28396ca4be1d7a4bb9fd9d7d4966785609612d3d9c1609105c83

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