Metadata-Version: 2.5
Name: nbgitpuller_jl_interface
Version: 1.1.1
Summary: A human interface with nbgitpuller in JupyterLab
Project-URL: Homepage, https://github.com/ASFOpenSARlab/nbgitpuller-jl-interface
Project-URL: Bug Tracker, https://github.com/ASFOpenSARlab/nbgitpuller-jl-interface/issues
Project-URL: Repository, https://github.com/ASFOpenSARlab/nbgitpuller-jl-interface.git
Author-email: OpenScienceLab <admin@opensciencelab.asf.alaska.edu>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: jupyter-server<3,>=2.13.0
Requires-Dist: nbgitpuller>=1.2.2
Provides-Extra: dev
Requires-Dist: jupyter-builder>=1.2.0; extra == 'dev'
Requires-Dist: jupyterlab>=4; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
Requires-Dist: pytest-mock; extra == 'test'
Description-Content-Type: text/markdown

# nbgitpuller_jl_interface

[![Github Actions Status](https://github.com/ASFOpenSARlab/nbgitpuller-jl-interface/workflows/Build/badge.svg)](https://github.com/ASFOpenSARlab/nbgitpuller-jl-interface/actions/workflows/build.yml)

A human interface with nbgitpuller in JupyterLab

This extension is composed of a Python package named `nbgitpuller_jl_interface`
for the server extension and a NPM package named `nbgitpuller-jl-interface`
for the frontend extension.

## Requirements

- JupyterLab >= 4.0.0

## Install

To install the extension, execute:

```bash
pip install nbgitpuller_jl_interface
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall nbgitpuller_jl_interface
```

## Usage

### Pull Repository Changes

To update your repositories, click the update button.

![Repository update button](./images/update_repos.png)

### Edit Settings

You can find the extension settings by clicking the gear icon.

![Go to settings](./images/goto_settings.png)

#### Apply Changes

To apply changes, the widget must be reloaded. Check the `Reload Widget` checkbox to reload the widget. It will uncheck itself after the widget is reloaded.

![Reload Widget](./images/reload_widget.png)

#### Add More Repositories

In nbgitpuller-jl-interface settings, under Repositories click the plus icon. Fill out the following fields.

- repoUrl: The repository URL
- branch: The branch of the repository to watch
- destPath: The destination folder to download the repository to

![Settings](./images/add_repo.png)

#### Additional Settings

**Automatic Updates**: If on will automatically pull repository updates on server start or browser refresh.

**Probe Interval**: The interval between probes for repository updates. Defaults to 15 minutes

**Relative Rank**: Affects position of widget in the menu bar.

## Troubleshoot

If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:

```bash
jupyter server extension list
```

If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:

```bash
jupyter labextension list
```

## Contributing

If you would like to contribute to this extension, please refer to the [Contributing Guide](CONTRIBUTING.md).
