📓 Open Jupyter notebooks from GitHub repositories or URLs directly in Jupyter.
Very useful in conjunction with uvx.
Tip
Try uvx --with "pipefunc[docs]" opennb pipefunc/pipefunc/example.ipynb to open a notebook from the pipefunc repository and ensure its dependencies are installed.
- 📦 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
uvxfor dependency management - 👽 Also works with Jupytext
.mdor.pynotebooks
Open a notebook from a GitHub repository:
opennb owner/repo/path/to/notebook.ipynbThis defaults to the default branch of the repository.
Or specify a specific branch:
opennb owner/repo@branch#path/to/notebook.ipynbOpen directly from a URL:
opennb https://example.com/notebook.ipynbImportant
opennb is especially useful when used with uvx.
Use with uvx to install dependencies and open a notebook in one go:
uvx --with dependency opennb owner/repo/path/to/notebook.ipynbFor example, to open a notebook from the pipefunc repository and ensure its dependencies are installed:
uvx --with "pipefunc[docs]" opennb pipefunc/pipefunc/example.ipynbAll arguments after the notebook specification are passed directly to jupyter notebook:
opennb owner/repo/notebook.ipynb --port 8888 --no-browserOpen a notebook from the main branch:
opennb owner/repo/notebook.ipynbOpen from a specific branch:
opennb jupyter/notebook@main#docs/source/examples/Notebook/Notebook%20Basics.ipynbOpen with custom Jupyter settings:
opennb owner/repo/notebook.ipynb --NotebookApp.token='my-token'Install using pip:
pip install opennbOr using uv:
uv pip install opennbMIT License
Contributions are welcome! Please feel free to submit a Pull Request.