nbgitpuller-link
Generate an nbgitpuller link through a CLI
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 1 committers (100.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Keywords
Repository
Generate an nbgitpuller link through a CLI
Basic Info
Statistics
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 5
- Releases: 1
Topics
Metadata Files
README.md
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:
```bash
$ 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:
bash
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:
bash
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:
python
from nbgitpuller_link import Link
Generate a link though a Link instance:
python
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:
python
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
Owner
- Name: Mark Piper
- Login: mdpiper
- Kind: user
- Company: University of Colorado Boulder
- Website: https://colorado.edu/instaar/mark-piper
- Repositories: 113
- Profile: https://github.com/mdpiper
Marshaller of models @csdms
Citation (CITATION.cff)
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Piper
given-names: Mark
orcid: https://orcid.org/0000-0001-6418-277X
title: "nbgitpuller-link"
version: 0.2
doi: 10.5281/zenodo.4721583
date-released: 2021-04-26
GitHub Events
Total
- Issues event: 1
Last Year
- Issues event: 1
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Mark Piper | m****r@c****u | 99 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 8
- Total pull requests: 7
- Average time to close issues: 2 months
- Average time to close pull requests: about 2 hours
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 0.5
- Average comments per pull request: 0.14
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mdpiper (8)
Pull Request Authors
- mdpiper (8)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 61 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 10
- Total maintainers: 1
pypi.org: nbgitpuller-link
Create an nbgitpuller link
- Homepage: https://github.com/mdpiper/nbgitpuller-link
- Documentation: https://github.com/mdpiper/nbgitpuller-link#readme
- License: MIT License
-
Latest release: 0.2.5
published almost 2 years ago
Rankings
Maintainers (1)
conda-forge.org: nbgitpuller-link
Use nbgitpuller-link to create an URL used by nbgitpuller <https://jupyterhub.github.io/nbgitpuller> to provision files from a git repository on a JupyterHub. nbgitpuller-link has a handy, scriptable CLI and a Python API.
- Homepage: https://github.com/mdpiper/nbgitpuller-link
- License: MIT
-
Latest release: 0.2.2
published over 3 years ago
Rankings
Dependencies
- actions/checkout v2 composite
- actions/setup-python v4 composite
- actions/setup-python v2 composite
- click *
- validators *
- black
- build
- click
- coveralls
- flake8
- isort
- nox
- pip
- pytest
- pytest-cov
- pytest-datadir
- python 3.*
- twine
- validators
- zest.releaser