# jupyterlab-git **Repository Path**: liujiaqi9682/jupyterlab-git ## Basic Information - **Project Name**: jupyterlab-git - **Description**: A Git extension for JupyterLab - **Primary Language**: TypeScript - **License**: BSD-3-Clause - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2021-09-15 - **Last Updated**: 2021-09-15 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # jupyterlab-git [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-git/master?urlpath=lab/tree/examples/demo.ipynb) [![Build Status](https://travis-ci.org/jupyterlab/jupyterlab-git.svg?branch=master)](https://travis-ci.org/jupyterlab/jupyterlab-git) [![Version](https://img.shields.io/npm/v/@jupyterlab/git.svg)](https://www.npmjs.com/package/@jupyterlab/git) [![Version](https://img.shields.io/pypi/v/jupyterlab-git.svg)](https://pypi.org/project/jupyterlab-git/) [![Downloads](https://img.shields.io/npm/dm/@jupyterlab/git.svg)](https://www.npmjs.com/package/@jupyterlab/git) [![Version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-git.svg)](https://anaconda.org/conda-forge/jupyterlab-git) [![Downloads](https://img.shields.io/conda/dn/conda-forge/jupyterlab-git.svg)](https://anaconda.org/conda-forge/jupyterlab-git) [![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-) A JupyterLab extension for version control using Git ![ui_glow_up](./docs/figs/demo-0-10-0.gif) To see the extension in action, open the example notebook included in the Binder [demo](https://mybinder.org/v2/gh/jupyterlab/jupyterlab-git/master?urlpath=lab/tree/examples/demo.ipynb). ## Prerequisites - JupyterLab - Git (version `>=2.x`) ## Usage - Open the Git extension from the _Git_ tab on the left panel ## Install To install perform the following steps: ```bash pip install --upgrade jupyterlab-git jupyter lab build ``` ## Settings Once installed, extension behavior can be modified via the following settings which can be set in JupyterLab's advanced settings editor: - **disableBranchWithChanges**: disable all branch operations, such as creating a new branch or switching to a different branch, when there are changed/staged files. When set to `true`, this setting guards against overwriting and/or losing uncommitted changes. - **doubleClickDiff**: double click a file in the Git UI to open a diff of the file instead of opening the file for editing. - **historyCount**: number of commits shown in the history log, beginning with the most recent. Displaying a larger number of commits can lead to performance degradation, so use caution when modifying this setting. - **refreshInterval**: number of milliseconds between polling the file system for changes. In order to ensure that the UI correctly displays the current repository status, the extension must poll the file system for changes. Longer polling times increase the likelihood that the UI does not reflect the current status; however, longer polling times also incur less performance overhead. - **simpleStaging**: enable a simplified concept of staging. When this setting is `true`, all files with changes are automatically staged. When we develop in JupyterLab, we often only care about what files have changed (in the broadest sense) and don't need to distinguish between "tracked" and "untracked" files. Accordingly, this setting allows us to simplify the visual presentation of changes, which is especially useful for those less acquainted with Git. ### Troubleshooting Before consulting the following list, be sure the server extension and the frontend extension have the same version by executing the following commands: ```bash jupyter serverextension list jupyter labextension list ``` - **Issue**: the Git panel does not recognize that you are in a Git repository. Possible fixes: - Be sure to be in a Git repository in the filebrowser tab - Check the server log. If you see a warning with a 404 code similar to: `[W 00:27:41.800 LabApp] 404 GET /git/server_root?1576081660665` Explicitly enable the server extension by running: ```bash jupyter serverextension enable --py jupyterlab_git ``` - If you are using JupyterHub or some other technologies requiring an initialization script which includes the jupyterlab-git extension, be sure to install both the frontend and the server extension **before** launching JupyterLab. - **Issue**: the Git panel is not visible. Possible fixes: - Check that the JupyterLab extension is installed: ```bash jupyter labextension list ``` If you don't see `@jupyterlab/git v... enabled OK` in the list, explicitly install the jupyter labextension by running: ```bash jupyter labextension install @jupyterlab/git ``` ## Development ### Contributing If you would like to contribute to the project, please read our [contributor documentation](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md). JupyterLab follows the official [Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md). ### Install Requires NodeJS ```bash # 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 --sys-prefix # Build the labextension and dev-mode link it to jlab jlpm jupyter labextension link . ``` To rebuild the package after a change and the JupyterLab app: ```bash jlpm run build jupyter lab build ``` To continuously monitor the project for changes and automatically trigger a rebuild, start Jupyter in watch mode: ```bash jupyter lab --watch ``` And in a separate session, begin watching the source directory for changes: ```bash jlpm run watch ``` Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times). To execute the tests ```bash pytest jupyterlab_git jlpm run test ``` ## Contributors ✨ The Jupyter Git extension is part of [Project Jupyter](http://jupyter.org/) and is developed by an open community of contributors. To see who has been active recently, please look at the ["Contributors"](https://github.com/jupyterlab/jupyterlab-git/graphs/contributors) tab. Below we list the people and entities who contributed in different ways to the project ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Amazon Web Services
🀝
Ashutosh Bondre
πŸ’» πŸ‘€
Athan
πŸ’» πŸ‘€ πŸ“† 🎨
Brian E. Granger
πŸ“† 🎨 πŸ€” πŸ”
FrΓ©dΓ©ric Collonval
🚧
Hana Zarea
πŸ’» πŸ‘€
Jaipreet Singh
πŸ“† πŸ‘€ πŸ’» 🎨

Ji Zhang
πŸ’» πŸ‘€
Konstantin Taletskiy
πŸ’» πŸ‘€
Max Klein
πŸ’» πŸ‘€ πŸ“† 🎨 πŸš‡
Neelam Gehlot
πŸ’» πŸ‘€
Noah Stapp
πŸ’» πŸ‘€
Saul Shanabrook
πŸ’» πŸ“† πŸ‘€ πŸš‡
The D. E. Shaw Group
🀝

jupytercalpoly
🀝
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! To add yourself, or someone else, to this list you can either [use the bot](https://allcontributors.org/docs/en/bot/usage) (`@all-contributors please add for `) or [the CLI](https://allcontributors.org/docs/en/cli/usage) (`jlpm all-contributors add `). If you manually edit the `.all-contributorsrc` config file, run `yarn run contributors:generate`