Narnia Protect Me

    jupyterlab-media-capture
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.0 • Public • Published

    jupyterlab_media_capture

    Github Actions Status

    Capture media using browser APIs within JupyterLab

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

    Requirements

    • JupyterLab >= 3.0

    Install

    pip install jupyterlab_media_capture

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

    Uninstall

    pip uninstall jupyterlab_media_capture

    Install

    npm i jupyterlab-media-capture

    DownloadsWeekly Downloads

    9

    Version

    0.4.0

    License

    Apache-2.0

    Unpacked Size

    27.9 kB

    Total Files

    14

    Last publish

    Collaborators

    • reevejd