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

    apache-beam-jupyterlab-sidepanel
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    apache-beam-jupyterlab-sidepanel

    A side panel providing information and controls to run Apache Beam notebooks interactively.

    Requirements

    • JupyterLab >= 2.0

    Install (WIP)

    jupyter labextension install apache-beam-jupyterlab-sidepanel

    Contributing

    Install

    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 
    # Move to apache-beam-jupyterlab-sidepanel directory 
     
    # Install dependencies 
    jlpm
    # Build Typescript source 
    jlpm build
    # Link your development version of the extension with JupyterLab 
    jupyter labextension link .
     
    # Rebuild Typescript source after making changes 
    jlpm build
    # Rebuild JupyterLab after making any changes 
    jupyter lab build

    You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

    # Watch the source directory in another terminal tab 
    jlpm watch
    # Run jupyterlab in watch mode in one terminal tab 
    jupyter lab --watch

    Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

    Test

    To run all tests, under apache-beam-jupyterlab-sidepanel directory, simply do:

    # Make sure all dependencies are installed. 
    jlpm
     
    # Run all tests. 
    jlpm jest

    This project uses ts-jest to test all ts/tsx files under src/__tests__ directory.

    To run a single test, find out the name of a test in the source code that looks like:

    it('does ABC', () => {...})

    Then run:

    jlpm jest -t 'does ABC'

    Format and lint

    The project uses prettier for formatting and eslint for lint. Prettier is configured as a plugin used by eslint. There are pre-configured yarn scripts to execute them.

    # Under apache-beam-jupyterlab-sidepanel directory. 
     
    # Make sure dependencies are installed. 
    # Prettier and eslint are both installed as dev dependencies. 
    jlpm
     
    # Check format and lint issues. 
    jlpm eslint:check
     
    # Check then fix in place format and lint issues. 
    jlpm eslint

    Uninstall

    jupyter labextension uninstall apache-beam-jupyterlab-sidepanel

    Install

    npm i apache-beam-jupyterlab-sidepanel

    DownloadsWeekly Downloads

    4

    Version

    1.0.0

    License

    Apache-2.0

    Unpacked Size

    102 kB

    Total Files

    62

    Last publish

    Collaborators

    • avatar