National Pest Management

    @tiledb-inc/tiledb_prompt_options
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.9 • Public • Published

    tiledb-prompt-options

    Github Actions Status

    TileDB notebook extension to prompt user for notebook options

    This extension is composed of a Python package named tiledb-prompt-options for the server extension and a NPM package named @tiledb-inc/tiledb_prompt_options for the frontend extension.

    Requirements

    • JupyterLab >= 3.0

    Install

    To install the extension, execute:

    pip install tiledb-prompt-options

    Uninstall

    To remove the extension, execute:

    pip uninstall tiledb-prompt-options

    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 tiledb-prompt-options directory
    # Install package in development mode
    python -m pip install .
    # 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 tiledb-prompt-options
    # 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

    Development uninstall

    # Server extension must be manually disabled in develop mode
    jupyter server extension disable tiledb-prompt-options
    pip uninstall tiledb-prompt-options

    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 @tiledb-inc/tiledb_prompt_options within that folder.

    Packaging the extension

    See RELEASE

    Install

    npm i @tiledb-inc/tiledb_prompt_options

    DownloadsWeekly Downloads

    2

    Version

    1.0.9

    License

    MIT

    Unpacked Size

    30.1 kB

    Total Files

    30

    Last publish

    Collaborators

    • kostas_tiledb
    • tiledbseth
    • stavrospapadopoulos
    • alextiledb