nbgitpuller-link 0.2.3

Create an nbgitpuller link

nbgitpuller-link

Generate an nbgitpuller link through a command-line interface or Python code.

Installation

Install the latest stable release of nbgitpuller-link with pip:

pip install nbgitpuller-link

or with conda:

conda install nbgitpuller-link -c conda-forge

To install from source, after cloning or downloading the nbgitpuller-link repository, change into the repository directory and install the package with pip:

pip install -e .

Examples

The nbgitpuller-link package includes a CLI and a Python API. The repository holds short examples of both, which are adapted here.

Shell

To see how to use the CLI, call nbgitpuller-link with the --help option:

$ nbgitpuller-link --help
Usage: nbgitpuller-link [OPTIONS]

  Generate an nbgitpuller link to load a repository on a JupyterHub

Options:
  --version                   Show the version and exit.
  --jupyterhub-url TEXT       Target JupyterHub for link.  [required]
  --repository-url TEXT       Source repository for link.  [required]
  --branch TEXT               Branch to use from source repository.  [default:
                              main]
  --launch-path TEXT          Relative path to file or directory in source
                              repository to launch on target JupyterHub.
                              [default: ]
  --interface [notebook|lab]  Open with classic Jupyter Notebook interface or
                              next-generation JupyterLab.  [default: notebook]
  --help                      Show this message and exit.

Generate a link to load a repository on a JupyterHub, specifying the file to launch and the branch to use:

nbgitpuller-link \
    --jupyterhub-url=https://csdms.rc.colorado.edu \
    --repository-url=https://github.com/csdms/espin \
    --branch=main \
    --launch-path=lessons/jupyter/index.ipynb

The resulting link:

https://csdms.rc.colorado.edu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fespin&urlpath=tree%2Fespin%2Flessons%2Fjupyter%2Findex.ipynb&branch=main

Python

Start a Python session and import the Link class from the nbgitpuller-link package:

from nbgitpuller_link import Link

Generate a link though a Link instance:

linker = Link(
    jupyterhub_url="https://csdms.rc.colorado.edu",
    repository_url="https://github.com/csdms/espin",
    branch="main",
    launch_path="lessons/jupyter/index.ipynb",
    interface="lab",
    )

Note that this example uses the JupyterLab interface.

The link property holds the URL:

print("The nbgitpuller link is:\n{}".format(linker.link))

The nbgitpuller link is:
https://csdms.rc.colorado.edu/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fespin&urlpath=lab%2Ftree%2Fespin%2Flessons%2Fjupyter%2Findex.ipynb%3Fautodecode&branch=main

MIT License

Copyright (c) 2021 Mark Piper

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.