Skip to main content

jupyterlab-playback

A JupyterLab extension.

This extension is composed of a Python package named jupyterlab-playback for the server extension and a NPM package named jupyterlab-playback for the frontend extension.

Command List

AUDIO

Generates audio from the text on the current line.

AUDIOALT

Format: AUDIOALT|[text]
Generates audio from the text provided after the command.

TYPE

Types the text on the current line.

PAUSE

Format: PAUSE[number]
Pauses playback for the specified number of milliseconds.

SELECT

Format: SELECT[line number]
Highlights the line specified by the given line number.

EXECUTE

Executes the current cell.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab-playback

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-playback

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

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-playback directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab-playback
# 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab-playback
pip uninstall jupyterlab-playback

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 jupyterlab-playback within that folder.

Testing the extension

Server tests

This extension is using Pytest for Python code testing.

Install test dependencies (needed only once):

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

To execute them, run:

pytest -vv -r ap --cov jupyterlab-playback

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.

Packaging the extension

See RELEASE

Metadata

Release files for jupyterlab-playback 0.1.8

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

Source distribution (sdist)

Source distribution for jupyterlab-playback 0.1.8
File Size Uploaded Provenance Actions
jupyterlab_playback-0.1.8.tar.gz 178.9 kB Without provenance Details for jupyterlab_playback-0.1.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlab-playback 0.1.8
File Interpreter ABI Platform Actions
jupyterlab_playback-0.1.8-py3-none-any.whl Python 3 none any Details for jupyterlab_playback-0.1.8-py3-none-any.whl

Total release size: 233.1 kB

Release files / jupyterlab_playback-0.1.8.tar.gz

Download URL jupyterlab_playback-0.1.8.tar.gz
Size 178.9 kB
Tags Source
SHA-256 checksum
How to use checksums
1bc6d0b084f49a1c7f070e1df643cc2aeedc7567ad87dc1d399a1cd0c5759d4b
BLAKE2b-256 checksum
How to use checksums
9d716536039884e80f8f8cf65cf43275d2a8af55ba009997f31bef96ada0af80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / jupyterlab_playback-0.1.8-py3-none-any.whl

Download URL jupyterlab_playback-0.1.8-py3-none-any.whl
Size 54.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
14effd8bdaea5f17d2c601e45cdef8f1a66b3c37093deb73a21d98e144181c87
BLAKE2b-256 checksum
How to use checksums
8c1bc9da8422f6d2b773845d7c2f59926faa5dd5bc480d04d46b6c60244dab33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Security for jupyterlab-playback 0.1.8

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