Skip to main content

Display collaborative inputs in JupyterLab

Project description

jupyterlab-collaborative-input

Display collaborative inputs in JupyterLab

Requirements

  • JupyterLab >= 4.0

Install

To install this package with pip run

pip install jupyterlab_collaborative_input

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 jupyterlab_collaborative_input 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.

# 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:

jupyter lab build --minimize=False

Publishing

Before starting, you'll need to have run: pip install twine jupyter_packaging

  1. Update the version in package.json and update the release date in CHANGELOG.md
  2. Commit the change in step 1, tag it, then push it
git commit -am <msg>
git tag vX.Z.Y
git push && git push --tags
  1. Create the artifacts
rm -rf dist build jupyterlab_collaborative_input/labextension
jlpm run build
python setup.py sdist bdist_wheel
  1. Test this against the test pypi. You can then install from here to test as well:
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_collaborative_input
  1. Upload this to pypi:
twine upload dist/*

Uninstall

pip uninstall jupyterlab_collaborative_input

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

jupyterlab_collaborative_input-0.1.0.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_collaborative_input-0.1.0.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_collaborative_input-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fc54a2b4b7a3f1456c4843a729c520132e65b12c7f4e9e3cf9f829f789aaef41
MD5 5d62f446a060031deee83794a1dff6ff
BLAKE2b-256 b9109aa7a58b3ac761f161c9a3fe8c4a170991f374216b2f0ce0530bd22e24b0

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_collaborative_input-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_collaborative_input-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89491ed65cb415bbf20b2087a842916f7e48e00819125a56851e2f233c045f07
MD5 1721c0710e2bd25a44d5a352444e6cdf
BLAKE2b-256 aabc34f98197bac0839fcd82491733d9c20511f30b3acad95f9643d53134b9d3

See more details on using hashes here.

Provenance

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