Skip to main content

nbtest_lab_extension

Github Actions Status

A JupyterLab extension for enabling/disabling nbtest assertions.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install nbtest_lab_extension

Uninstall

To remove the extension, execute:

pip uninstall nbtest_lab_extension

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

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

Metadata

Release files for nbtest-lab-extension 0.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nbtest-lab-extension 0.2.5
File Size Uploaded Provenance Actions
nbtest_lab_extension-0.2.5.tar.gz 354.7 kB Without provenance Details for nbtest_lab_extension-0.2.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nbtest-lab-extension 0.2.5
File Interpreter ABI Platform Actions
nbtest_lab_extension-0.2.5-py3-none-any.whl Python 3 none any Details for nbtest_lab_extension-0.2.5-py3-none-any.whl

Total release size: 569.4 kB

Release files / nbtest_lab_extension-0.2.5.tar.gz

Download URL nbtest_lab_extension-0.2.5.tar.gz
Size 354.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1c437901d2434468d01ff43960111960965872d2be51a4891abeec90f5e18680
BLAKE2b-256 checksum
How to use checksums
ffe4b726152ceec78130e9785895d8317118ab064788116ae73f83bcf3b6fc84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Release files / nbtest_lab_extension-0.2.5-py3-none-any.whl

Download URL nbtest_lab_extension-0.2.5-py3-none-any.whl
Size 214.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
296608a61324521edbf61e680f307c69bf5b5076f5f762c5db6e23cf621210f1
BLAKE2b-256 checksum
How to use checksums
10343196a1b271374fedf55a136bcccefbcd31b8458665e033914e5f1bd5d090
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Security for nbtest-lab-extension 0.2.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page