Skip to main content

Used to compress notebook content into a sharable url.

Project description

notebook_url

Github Actions Status Used to compress notebook content into a sharable url.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install notebook_url

Uninstall

To remove the extension, execute:

pip uninstall notebook_url

Contributing

Development install

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

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the notebook_url 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 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.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm 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 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:

jupyter lab build --minimize=False

Development uninstall

pip uninstall notebook_url

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named notebook-url within that folder.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notebook_url-0.2.9.tar.gz (158.6 kB view details)

Uploaded Source

Built Distribution

notebook_url-0.2.9-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file notebook_url-0.2.9.tar.gz.

File metadata

  • Download URL: notebook_url-0.2.9.tar.gz
  • Upload date:
  • Size: 158.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.0

File hashes

Hashes for notebook_url-0.2.9.tar.gz
Algorithm Hash digest
SHA256 87b2b0d8aba73ad8e42fa155305145c9eb4a17fe969c9b69e4075bebc230dcd1
MD5 438c73c1e581207ec072da08a3484fb0
BLAKE2b-256 583ba496e87214529fbef85ee63c6a6c626db6db4951eafca42ffeaca6495487

See more details on using hashes here.

File details

Details for the file notebook_url-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: notebook_url-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.0

File hashes

Hashes for notebook_url-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 11a174805e5c423fcc69c5c4f7135724648de5b61d1dda418e7e7a372079597e
MD5 603c875a3513b4be7171b9182fe6856b
BLAKE2b-256 0c2a1a2a49fd0a3686a51a398b7cf56df868e52a626194393e32b1e8d005103a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page