JupyterLab-Git

A JupyterLab расширение для контроля версий с использованием Git.

Рисунок 1. Демонстрация работы расширения (ui_glow_up.gif).

Чтобы увидеть расширение в действии, откройте пример ноутбука, включенный в Binder демо.

Предпосылки

JupyterLab;
Git версии >=2.x.

Использование

Откройте расширение Git на вкладке «Git» на левой панели.

Установка

Для установки выполните следующие шаги:

pip install --upgrade jupyterlab-git
jupyter lab build

Настройки

После установки поведение расширения можно изменить с помощью следующих настроек, которые можно установить в редакторе расширенных настроек JupyterLab:

disableBranchWithChanges: отключить все операции с ветками, такие как создание новой ветки или переход на другую ветку, когда есть измененные/поставленные файлы. Когда установлено значение true, эта настройка защищает от перезаписи и/или потери незафиксированных изменений.
doubleClickDiff: дважды щелкните файл в пользовательском интерфейсе Git, чтобы открыть разницу файла вместо открытия файла для редактирования.
historyCount: количество коммитов, отображаемых в журнале истории, начиная с самого последнего. Отображение большего количества коммитов может привести к снижению производительности, поэтому будьте осторожны при изменении этой настройки.
refreshInterval: количество миллисекунд между опросами файловой системы на предмет изменений. Чтобы убедиться, что пользовательский интерфейс правильно отображает текущий статус репозитория, расширение должно опрашивать файловую систему на предмет изменений. Более длительное время опроса увеличивает вероятность того, что пользовательский интерфейс не отражает текущий статус; однако более длительное время опроса также влечет за собой меньшие накладные расходы на производительность.
simpleStaging: включить упрощенное понятие постановки. Когда эта настройка имеет значение true, все файлы с изменениями автоматически ставятся. Когда мы разрабатываем в JupyterLab, нас часто волнует только то, какие файлы были изменены (в самом широком смысле), и нам не нужно различать «отслеживаемые» и «неотслеживаемые» файлы. Соответственно, эта настройка позволяет нам упростить визуальное представление изменений, что особенно полезно для тех, кто менее знаком с Git.

Устранение неполадок

Прежде чем обращаться к следующему списку, убедитесь, что серверное расширение и внешнее расширение имеют одинаковую версию, выполнив следующие команды:

jupyter serverextension list
jupyter labextension list

Проблема: панель Git не распознает, что вы находитесь в репозитории Git. Возможные исправления:
- Убедитесь, что находитесь в репозитории Git во вкладке filebrowser.
- Проверьте журнал сервера. Если вы видите предупреждение с кодом 404, похожим на: [W 00:27:41.800 LabApp] 404 GET /git/server_root?1576081660665 Явно включите расширение сервера, запустив:
```
jupyter serverextension enable --py jupyterlab_git
```
- Если вы используете JupyterHub или какую-либо другую технологию, требующую сценария инициализации, который включает расширение jupyterlab-git, обязательно установите оба. Фронтенд и серверное расширение перед запуском JupyterLab.

Проблема: панель Git не отображается. Возможные решения:
- Проверьте, установлено ли расширение JupyterLab:
```
jupyter labextension list
```
  Если вы не видите @jupyterlab/git v... enabled OK в списке, явно установите расширение jupyter labextension, выполнив:
```
jupyter labextension install @jupyterlab/git
```

Разработка

Вклад

Если вы хотите внести свой вклад в проект, ознакомьтесь с нашей документацией для участников. JupyterLab следует официальному Кодексу поведения Jupyter.

Установка

Требуется NodeJS

# Установите новый JupyterLab
pip install -U jupyterlab

# Клонируйте репозиторий в локальную среду
git clone https://github.com/jupyterlab/jupyterlab-git.git
cd jupyterlab-git

# Установите серверное расширение в режиме разработки и включите его
pip install -e .[test]
jupyter serverextension enable --py jupyterlab_git --sys-prefix

# Соберите пакет labextension и свяжите его с jlab в режиме разработчика
jlpm
jupyter labextension link .

Чтобы пересобрать пакет после изменения и приложения JupyterLab:

jlpm run build
jupyter lab build

Чтобы постоянно отслеживать проект на предмет изменений и автоматически запускать перестройку, запустите Jupyter в режиме наблюдения:

jupyter lab --watch

И в отдельном сеансе начните следить за исходным каталогом на предмет изменений:

jlpm run watch

Теперь каждое изменение будет собираться локально и включаться в JupyterLab. Обязательно обновите страницу браузера после сохранения изменений файла, чтобы перезагрузить расширение (обратите внимание: вам нужно дождаться завершения работы webpack, что может занять 10 секунд и более).

Для выполнения тестов:

pytest jupyterlab_git
jlpm run test

Участники ✨

Расширение Jupyter Git является частью Project Jupyter и разрабатывается открытым сообществом участников. Чтобы узнать, кто был активен недавно, посмотрите на вкладку «Участники». Ниже мы перечисляем людей и организации, которые внесли свой вклад в проект (ключ эмодзи):