https://github.com/jupyterhub/nbgitpuller

Jupyter server extension to sync a git repository one-way to a local path
https://github.com/jupyterhub/nbgitpuller

Last synced: 5 days ago
JSON representation

Jupyter server extension to sync a git repository one-way to a local path

• Host: GitHub
• URL: https://github.com/jupyterhub/nbgitpuller
• Owner: jupyterhub
• License: bsd-3-clause
• Created: 2017-05-24T19:41:10.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2025-01-27T15:34:26.000Z (24 days ago)
• Last Synced: 2025-02-08T08:01:33.786Z (12 days ago)
• Language: Python
• Homepage: https://nbgitpuller.readthedocs.io
• Size: 6.27 MB
• Stars: 215
• Watchers: 16
• Forks: 88
• Open Issues: 84
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jupyter-resources - GitHub - 39% open · ⏱️ 22.06.2022): (Jupyter拓展)
• best-of-jupyter - GitHub - 47% open · ⏱️ 27.01.2025): (Jupyter Extensions)
• awesome-jupyter - nbgitpuller - Sync a git repository one-way to a local path. (Collaboration/Education)
• awesome-starred - jupyterhub/nbgitpuller - Jupyter server extension to sync a git repository one-way to a local path (others)

README

        
# [nbgitpuller](https://github.com/jupyterhub/nbgitpuller)

[![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/nbgitpuller/Tests?logo=github&label=tests)](https://github.com/jupyterhub/nbgitpuller/actions)

[![Documentation Status](https://readthedocs.org/projects/nbgitpuller/badge/?version=latest)](https://nbgitpuller.readthedocs.io/en/latest/?badge=latest)

[![](https://img.shields.io/pypi/v/nbgitpuller.svg?logo=pypi)](https://pypi.python.org/pypi/nbgitpuller)

[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/nbgitpuller/issues)

[![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)

[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)

`nbgitpuller` lets you distribute content in a git repository to your students

by having them click a simple link. [Automatic

merging](https://nbgitpuller.readthedocs.io/en/latest/topic/automatic-merging.html)

ensures that your students are never exposed to `git` directly. It is primarily

used with a JupyterHub, but can also work on students' local computers.

See [the documentation](https://nbgitpuller.readthedocs.io) for more

information.

## Installation

```shell

pip install nbgitpuller

```

## Example

This example shows how to use the [nbgitpuller link generator]

to create an nbgitpuller link, which a user then clicks.

[nbgitpuller link generator]: https://nbgitpuller.readthedocs.io/en/latest/link.html

1. The nbgitpuller link generator GUI is used to create a

   link.

   ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-link-generator.png)

2. This link is clicked, and the content is pulled into a live Jupyter session.

   ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-demo.gif)