Using nbgitpuller¶
Overview of nbgitpuller links¶
nbgitpullerlinks may be sent to your users via any method you like - websites, emails, a learning management system, etc.
This link will contain at least the following information:
The location of the JupyterHub you are sending them to.
The git repository where you have published your content.
Optionally, a particular file or directory you want to automatically open after the content is pulled.
Optionally, which UI should be opened when the user clicks the link. By default
nbgitpulleruses the classic notebook interface - but you may instead use JupyterLab, RStudio, Linux Desktop, etc based on what you have available in your JupyterHub. open for your students once the repository has been synchronized. Note the entire repository will be copied, not just the specified file.
The first time a particular student clicks the link, a local copy of the repository is made for the student. On successive clicks, the latest version of the remote repository is fetched, and merged automatically with the student’s local copy using a series of rules that ensure students never get merge conflicts nor lose any of their changes.
Create an nbgitpuller link via a web extension¶
The easiest way to create an nbgitpuller link is via a web extension (github repo).
This allows you to quickly generate an nbgitpuller link directly from the content in your repository (e.g., on GitHub).
See the links below to download the extension.
Automatically create an nbgitpuller link via a web app¶
You can also create an nbgitpuller link via a GUI web app at the below link:
This contains a simple web form where you paste the location of the content you’d like your users to pull, and it will generate a link for you to distribute.
Manually create an nbgitpuller link¶
There is a short video showing
If you are interested in the details of available options when creating the link, we have a list of options as well.