Skip to main content

Open Jupyter notebooks from GitHub repositories or URLs directly in Jupyter.

Project description

opennb 📓

PyPI Python Versions

📓 Open Jupyter notebooks from GitHub repositories or URLs directly in Jupyter. Very useful in conjunction with uv run.

Installation

Install using pip:

pip install opennb

Or using uv:

uv pip install opennb

Usage

Open a notebook from a GitHub repository:

opennb owner/repo#path/to/notebook.ipynb

Specify a branch:

opennb owner/repo@branch#path/to/notebook.ipynb

Open directly from a URL:

opennb https://example.com/notebook.ipynb

Use with uv run to install dependencies and open a notebook in one go:

uv run --from owner/repo opennb owner/repo#path/to/notebook.ipynb

For example, to open a notebook from the pipefunc repository and ensure its dependencies are installed:

uv run --from pipefunc --from notebook opennb pipefunc/pipefunc/example.ipynb

Arguments

All arguments after the notebook specification are passed directly to jupyter notebook:

opennb owner/repo#notebook.ipynb --port 8888 --no-browser

Examples

Open a notebook from the main branch:

opennb scipy/scipy#doc/source/tutorial/basic.ipynb

Open from a specific branch:

opennb pandas-dev/pandas@main#doc/source/getting_started/intro_tutorials/01_table_oriented.ipynb

Open with custom Jupyter settings:

opennb owner/repo#notebook.ipynb --NotebookApp.token='my-token'

Features

  • 📦 Open notebooks directly from GitHub repositories
  • 🔄 Automatic default branch detection
  • 🌳 Support for specific branches
  • 🔗 Direct URL support
  • 🚀 Pass-through of Jupyter notebook arguments
  • 📥 Integration with uv run for dependency management

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

opennb-0.1.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

opennb-0.1.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file opennb-0.1.0.tar.gz.

File metadata

  • Download URL: opennb-0.1.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for opennb-0.1.0.tar.gz
Algorithm Hash digest
SHA256 062882cc2f8466982267f4ad2fd6579019db371a9847b1137973723ff5e5ef0d
MD5 fc8ebdc861c98302d93b9d06921dd97c
BLAKE2b-256 5370d52c654e5873a98d5bf78cf53350eb87df29003dfc83f54361a9c9f9cf70

See more details on using hashes here.

Provenance

The following attestation bundles were made for opennb-0.1.0.tar.gz:

Publisher: release.yml on basnijholt/opennb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opennb-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: opennb-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for opennb-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed42d66b94650fedd307940edd16e7cd815fae2eab133955644c92a98aab2106
MD5 15f4e4df0c6deeb83fab7ac62e3c9532
BLAKE2b-256 aef94004909da3fdb517f5c0391e2e171bd2d994c09cba64b2f54733d880a4d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for opennb-0.1.0-py3-none-any.whl:

Publisher: release.yml on basnijholt/opennb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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