Have ideas to improve npm?Join in the discussion! »

    nglview-js-widgets

    3.0.0 • Public • Published

    NOTE: Check "npm install && npm run copy:labextension"

    nglview-js-widgets

    Github Actions Status

    nglview-js-widgets

    Requirements

    • JupyterLab >= 3.0

    Install

    pip install nglview-js-widgets

    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 nglview-js-widgets 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 nglview-js-widgets

    Install

    npm i nglview-js-widgets

    DownloadsWeekly Downloads

    1,047

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    9.94 MB

    Total Files

    42

    Last publish

    Collaborators

    • avatar