Skip to main content

A JupyterLab extension.

Project description

send_3_test

Github Actions StatusBinder A JupyterLab extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install send_3_test

Uninstall

To remove the extension, execute:

pip uninstall send_3_test

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 send_3_test 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 send_3_test

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 send-3-test within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

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

send_3_test-0.1.0.tar.gz (223.0 kB view details)

Uploaded Source

Built Distribution

send_3_test-0.1.0-py3-none-any.whl (56.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: send_3_test-0.1.0.tar.gz
  • Upload date:
  • Size: 223.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for send_3_test-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7f687d5ea521967faeb7d12efe30eecf49cd0a039113f0cd6b6f22680cc4032e
MD5 e21327d1543e063560ee2546b4204fc1
BLAKE2b-256 89341f6ff0cd81ddf43866a34aa53715f5587af9e00a81fddff9a1bf3ed76bf4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: send_3_test-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 56.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for send_3_test-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 919967a1e50a9735dfa21b118580443ee3a9e06bdeb61e98cc33ad4e393365ee
MD5 9bb05670408489a14e0e0b1a0a4eabe3
BLAKE2b-256 95c8dcad5eb6f6f8e9bf46d5d1951a03d572240e25c17f9c86a884a4b4b1e6b9

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