Metadata-Version: 2.1
Name: jupyterlab-vpython
Version: 3.0.4
Summary: VPython extension for JupyterLab
Home-page: https://github.com/jcoady/jupyterlab_vpython
Author: John Coady
Author-email: johncoady@shaw.ca
License: BSD-3-Clause
Description: # jupyterlab_vpython
        
        ![Github Actions Status](https://github.com/jcoady/jupyterlab_vpython/workflows/Build/badge.svg)
        
        VPython extension for JupyterLab
        
        
        
        ## Requirements
        
        * JupyterLab >= 3.0
        
        ## Install
        
        ```bash
        pip install jupyterlab_vpython
        ```
        
        
        ## 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_vpython directory
        # Install package in development mode
        pip install -e .
        # Link your development version of the extension with JupyterLab
        jupyter labextension develop . --overwrite
        # If using a server extension, it must be manually installed in develop mode
        jupyter server extension enable <extension_name>
        # 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_vpython
        ```
        
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: Programming Language :: Python :: 3.9
Classifier: Framework :: Jupyter
Requires-Python: >=3.6
Description-Content-Type: text/markdown
