Metadata-Version: 2.1
Name: jupyterlab-kernelspy
Version: 3.0.2
Summary: A Jupyter Lab extension for inspecting messages to/from a kernel
Home-page: https://github.com/jupyterlab-contrib/jupyterlab-kernelspy.git
Author: Vidar Tonaas Fauske
License: BSD-3-Clause
Description: # jupyterlab-kernelspy
        
        [![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/actions?query=workflow%3ABuild)
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-kernelspy/master?urlpath=lab)
        
        A Jupyter Lab extension for inspecting messages to/from a kernel.
        
        ![screenshot](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-kernelspy/master/screenshot.png)
        
        ## Requirements
        
        - JupyterLab
        
        ## Install
        
        ```bash
        pip install jupyterlab-kernelspy
        ```
        
        ## Update
        
        From JupyterLab 3.0 onwards, extensions are distributed as Python packages. Use the same Python
        package manager you used to install the extension to update it.
        
        For JupyterLab 0.34 - 2.2.x, you can update the extension to the latest compatible version with:
        
        ```bash
        jupyter labextension update jupyterlab-kernelspy
        ```
        
        ## Usage
        
        Once the extension is installed, it should add a button to your notebook toolbar (a yellow `{:}` icon).
        Click this button to open a log view for that notebook.
        
        ## Contributing
        
        ### Development install
        
        Note: You will need NodeJS to build the extension package.
        
        The `jlpm` command is JupyterLab's pinned version of
        [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
        `yarn` or `npm` in lieu of `jlpm` below.
        
        ```bash
        # Clone the repo to your local environment
        # Change directory to the jupyterlab-kernelspy 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.
        
        ```bash
        # 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:
        
        ```bash
        jupyter lab build --minimize=False
        ```
        
        ### Uninstall
        
        ```bash
        pip uninstall jupyterlab-kernelspy
        ```
        
Keywords: Jupyter,JupyterLab,JupyterLab3
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Jupyter
Requires-Python: >=3.6
Description-Content-Type: text/markdown
