Skip to main content

A server extension for JupyterLab's git extension

Project description

jupyterlab-git

Binder Build Status Version Version Downloads Version Downloads

A JupyterLab extension for version control using git

To see the extension in action, open the example notebook included in the Binder demo.

Prerequisites

  • JupyterLab

Usage

  • Open the git extension from the Git tab on the left panel

Install

To install perform the following steps:

pip install --upgrade jupyterlab-git
jupyter lab build

Troubleshooting

  • When you run JupyterLab, if you can see the Git sidepanel UI but you cannot get it to work, you may need to explicitly enable the serverextension by running:
jupyter serverextension enable --py jupyterlab_git

Development

Contributing

If you would like to contribute to the project, please read our contributor documentation.

JupyterLab follows the official Jupyter Code of Conduct.

Team

The Jupyter Git extension is part of Project Jupyter and is developed by an open community of contributors. Our maintainer team is accompanied by a much larger group of contributors to JupyterLab and Project Jupyter as a whole.

JupyterLab Git's current maintainers are listed in alphabetical order, with affiliation, and main areas of contribution:

  • Brian Granger, Cal Poly (co-creator, strategy, vision, management, UI/UX design, architecture).
  • Saul Shanabrook, Quansight(software engineering)
  • Jaipreet Singh, AWS (software engineering, UI/UX design, management)
  • Frederic Collonval, Safran Group (software engineering)

A lot of awesome people have contributed to this repo - See the contributors tab for more details!

This list is provided to help provide context about who we are and how our team functions. If you would like to be listed, please submit a pull request with your information.

Install

Requires node 4+ and npm 4+

# Install new-ish JupyterLab
pip install -U jupyterlab

# Clone the repo to your local environment
git clone https://github.com/jupyterlab/jupyterlab-git.git
cd jupyterlab-git

# Install the server extension in development mode and enable it
pip install -e .[test]
jupyter serverextension enable --py jupyterlab_git

# Build the labextension and dev-mode link it to jlab
jlpm build
jupyter labextension link .

To rebuild the package after a change and the JupyterLab app:

jlpm run build
jupyter lab build

To execute the tests

pytest jupyterlab_git
jlpm run test

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_git-0.9.1.tar.gz (149.3 kB view details)

Uploaded Source

Built Distribution

jupyterlab_git-0.9.1-py3-none-any.whl (144.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_git-0.9.1.tar.gz.

File metadata

  • Download URL: jupyterlab_git-0.9.1.tar.gz
  • Upload date:
  • Size: 149.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.1.post20200322 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for jupyterlab_git-0.9.1.tar.gz
Algorithm Hash digest
SHA256 77a6b791a4bfeedfc81fbb6ef09308b49a0a21f045c14bae6a43267edc77408a
MD5 715b25e2821275d5c5e572c7daa5782c
BLAKE2b-256 0d8ea312e832604e8fd0d3d17b0f2966a4edffa8e0efb765259ad2ce46eb8e92

See more details on using hashes here.

File details

Details for the file jupyterlab_git-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_git-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 144.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.1.post20200322 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for jupyterlab_git-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd718da79b17ef3594714f05cee1f8486b3b05a3fa0d93915f7e0f524bc97bcd
MD5 24207e6cce2a450ddd08f6a424896f46
BLAKE2b-256 e4cdabc3751db0715ed33edf55c3b0500bee4ae4ac3b7a9dc9d0ab0dd38f6d9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page