Create an nbgitpuller link
Project description
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://lab.openearthscape.org \
--repository-url=https://github.com/csdms/ivy \
--branch=main \
--launch-path=lessons/bmi/index.ipynb
The resulting link:
https://lab.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fivy&urlpath=tree%2Fivy%2Flessons%2Fbmi%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://lab.openearthscape.org",
repository_url="https://github.com/csdms/ivy",
branch="main",
launch_path="lessons/bmi/index.ipynb",
interface="lab",
)
Note that this example uses the JupyterLab interface.
The link
property holds the URL:
print(f"The nbgitpuller link is:\n{linker.link}")
The nbgitpuller link is:
https://lab.openearthscape.org/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fcsdms%2Fivy&urlpath=lab%2Ftree%2Fivy%2Flessons%2Fbmi%2Findex.ipynb%3Fautodecode&branch=main
Changes: nbgitpuller-link
0.2.5 (2024-03-25)
- Test on Python 3.12, set minimum to 3.10 (#15)
0.2.4 (2023-01-11)
- Use nox for build system management (#13)
- Update examples (#12)
0.2.3 (2022-12-01)
- Fix incorrect urllib.parse import
0.2.2 (2022-07-21)
- Update contents of built distributions (#9)
0.2.1 (2022-06-22)
- Get DOI from Zenodo and add CITATION.cff
- Move metadata from setup.cfg to pyproject.toml (#8)
0.2 (2021-03-04)
- Add choice of classic Notebook or JupyterLab interface
- Test against known link
0.1 (2021-02-28)
- Initial release
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.
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
Built Distribution
Hashes for nbgitpuller_link-0.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b32f362924956965e200615aac8424e356aa174022cfb4960c88eeef128d0fd3 |
|
MD5 | 4a66a51d4b1222bc90c63854e5b3c8f4 |
|
BLAKE2b-256 | 683a4d6509c00ad60bd2d24b221a5d3e8e25e40246be89639d5b1da4949d6fdd |