A JupyterLab extension for version control using Git
To see the extension in action, open the example notebook included in the Binder demo.
>=2.x
)To install perform the following steps:
pip install --upgrade jupyterlab-git
jupyter lab build
Once installed, extension behavior can be modified via the following settings which can be set in JupyterLab's advanced settings editor:
true
, this setting guards against overwriting and/or losing uncommitted changes.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.Before consulting the following list, be sure the server extension and the frontend extension have the same version by executing the following commands:
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:
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:
jupyter labextension list
If you don't see @jupyterlab/git v... enabled OK
in the list, explicitly install the jupyter labextension by running:
jupyter labextension install @jupyterlab/git
If you would like to contribute to the project, please read our contributor documentation.
JupyterLab follows the official Jupyter Code of Conduct.
Requires NodeJS
# 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:
jlpm run build
jupyter lab build
To continuously monitor the project for changes and automatically trigger a rebuild, start Jupyter in watch mode:
jupyter lab --watch
And in a separate session, begin watching the source directory for changes:
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
pytest jupyterlab_git
jlpm run test
The Jupyter Git extension is part of Project Jupyter and is developed by an open community of contributors. To see who has been active recently, please look at the "Contributors" tab. Below we list the people and entities who contributed in different ways to the project (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
To add yourself, or someone else, to this list you can either use the bot (@all-contributors please add <username> for <contributions>
) or the CLI (jlpm all-contributors add <username> <contributions>
).
If you manually edit the .all-contributorsrc
config file, run yarn run contributors:generate
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型