Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jupyterlab-contrib/jupyterlab-link-share

JupyterLab Extension to easily share a link to a running server on Binder
https://github.com/jupyterlab-contrib/jupyterlab-link-share

jupyter jupyterlab jupyterlab-extension

Last synced: 4 months ago
JSON representation

JupyterLab Extension to easily share a link to a running server on Binder

Host: GitHub
URL: https://github.com/jupyterlab-contrib/jupyterlab-link-share
Owner: jupyterlab-contrib
License: bsd-3-clause
Created: 2021-01-14T14:10:23.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-10-08T10:23:34.000Z (9 months ago)
Last Synced: 2024-01-16T16:29:29.564Z (6 months ago)
Topics: jupyter, jupyterlab, jupyterlab-extension
Language: TypeScript
Homepage:
Size: 494 KB
Stars: 46
Watchers: 3
Forks: 14
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-starred - jupyterlab-contrib/jupyterlab-link-share - JupyterLab Extension to easily share a link to a running server on Binder (others)

README

# jupyterlab-link-share

[![Extension status](https://img.shields.io/badge/status-ready-success "ready to be used")](https://jupyterlab-contrib.github.io/)
[![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-link-share/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-link-share/actions/workflows/build.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-link-share/main?urlpath=/lab)

JupyterLab Extension to share the URL to a running Jupyter Server

![screencast](https://user-images.githubusercontent.com/591645/104604669-e0f53880-567d-11eb-989f-2bf2edd416ce.gif)

## Requirements

* JupyterLab >= 3.0

## Install

```bash
pip install jupyterlab-link-share
```

## Contributing

### Development install

Note: You will need NodeJS to build the extension package.

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab-link-share directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
```

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

```bash
jupyter lab build --minimize=False
```

### Uninstall

```bash
pip uninstall jupyterlab-link-share
```