nbgitpuller


Namenbgitpuller JSON
Version 1.2.1 PyPI version JSON
download
home_pagehttps://github.com/jupyterhub/nbgitpuller
SummaryJupyter Extension to do one-way synchronization of git repositories
upload_time2024-03-29 21:07:10
maintainerNone
docs_urlNone
authorPeter Veerman, YuviPanda
requires_pythonNone
license3-clause BSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # [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)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jupyterhub/nbgitpuller",
    "name": "nbgitpuller",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Peter Veerman, YuviPanda",
    "author_email": "peterkangveerman@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f2/73/2b27e4820a04e50e9eb275dee9893c60f559646b1ab7bc571834e1b80707/nbgitpuller-1.2.1.tar.gz",
    "platform": "any",
    "description": "# [nbgitpuller](https://github.com/jupyterhub/nbgitpuller)\n\n[![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/nbgitpuller/Tests?logo=github&label=tests)](https://github.com/jupyterhub/nbgitpuller/actions)\n[![Documentation Status](https://readthedocs.org/projects/nbgitpuller/badge/?version=latest)](https://nbgitpuller.readthedocs.io/en/latest/?badge=latest)\n[![](https://img.shields.io/pypi/v/nbgitpuller.svg?logo=pypi)](https://pypi.python.org/pypi/nbgitpuller)\n[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/nbgitpuller/issues)\n[![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)\n[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)\n\n`nbgitpuller` lets you distribute content in a git repository to your students\nby having them click a simple link. [Automatic\nmerging](https://nbgitpuller.readthedocs.io/en/latest/topic/automatic-merging.html)\nensures that your students are never exposed to `git` directly. It is primarily\nused with a JupyterHub, but can also work on students' local computers.\n\nSee [the documentation](https://nbgitpuller.readthedocs.io) for more\ninformation.\n\n## Installation\n\n```shell\npip install nbgitpuller\n```\n\n## Example\n\nThis example shows how to use the [nbgitpuller link generator]\nto create an nbgitpuller link, which a user then clicks.\n\n[nbgitpuller link generator]: https://nbgitpuller.readthedocs.io/en/latest/link.html\n\n1. The nbgitpuller link generator GUI is used to create a\n   link.\n\n   ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-link-generator.png)\n\n2. This link is clicked, and the content is pulled into a live Jupyter session.\n\n   ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-demo.gif)\n",
    "bugtrack_url": null,
    "license": "3-clause BSD",
    "summary": "Jupyter Extension to do one-way synchronization of git repositories",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://github.com/jupyterhub/nbgitpuller"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce1b57f179e069719c8c09319792d39243ace38d0db44ad30de49bb3ece5348b",
                "md5": "0fd11fe6d9a3b06127180a9641a28268",
                "sha256": "b0d055450b1395706faf34d8ccff2c43ba41e2aa8ddf5e4dbf38c0d96080d71e"
            },
            "downloads": -1,
            "filename": "nbgitpuller-1.2.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0fd11fe6d9a3b06127180a9641a28268",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 316890,
            "upload_time": "2024-03-29T21:07:08",
            "upload_time_iso_8601": "2024-03-29T21:07:08.555329Z",
            "url": "https://files.pythonhosted.org/packages/ce/1b/57f179e069719c8c09319792d39243ace38d0db44ad30de49bb3ece5348b/nbgitpuller-1.2.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f2732b27e4820a04e50e9eb275dee9893c60f559646b1ab7bc571834e1b80707",
                "md5": "3a4474ff82bb73e7a543d5d3bf1c6ac7",
                "sha256": "c3d8e13215d31387e0ef0d264cdc8676cfe4f364c27f3664b4e7bd04996ee64d"
            },
            "downloads": -1,
            "filename": "nbgitpuller-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3a4474ff82bb73e7a543d5d3bf1c6ac7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 323557,
            "upload_time": "2024-03-29T21:07:10",
            "upload_time_iso_8601": "2024-03-29T21:07:10.062042Z",
            "url": "https://files.pythonhosted.org/packages/f2/73/2b27e4820a04e50e9eb275dee9893c60f559646b1ab7bc571834e1b80707/nbgitpuller-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-29 21:07:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jupyterhub",
    "github_project": "nbgitpuller",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nbgitpuller"
}
        
Elapsed time: 0.33395s