Metadata-Version: 2.1
Name: swanintro
Version: 1.0.0
Summary: Information popup for SWAN
Home-page: https://github.com/swan-cern/jupyter-extensions
Author: SWAN Admins
License: AGPL-3.0
Description: # SwanIntro
        
        SWAN extension to show an information pop up to new users.
        
        
        This extension is composed of a Python package named `swanintro`, which installs the nbextension and a NPM package named `@swan-cern/swanintro`
        for the JupyterLab extension.
        
        
        ## Requirements
        
        * JupyterLab >= 2.0
        
        ## Install
        
        Note: You will need NodeJS to install the extension.
        
        ```bash
        pip install swanintro
        jupyter nbextension install swanintro --py
        jupyter nbextension enable  swanintro --py
        jupyter lab build
        ```
        
        ## Troubleshoot
        
        If you are not seeing the frontend, check if it's installed:
        
        ```bash
        jupyter labextension list
        ```
        
        If it is installed, try:
        
        ```bash
        jupyter lab clean
        jupyter lab build
        ```
        
        ## Contributing
        
        ### Install
        
        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
        # Move to swanintro directory
        
        # Install server extension
        # This will also build the js code
        pip install -e .
        
        # Install and enable the nbextension
        jupyter nbextension install swanintro --py --sys-prefix
        jupyter nbextension enable  swanintro --py --sys-prefix
        
        # Link your development version of the extension with JupyterLab
        jupyter labextension link .
        # Rebuild JupyterLab after making any changes
        jupyter lab build
        
        # 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.
        
        ```bash
        # Watch the source directory in another terminal tab
        jlpm watch
        # Run jupyterlab in watch mode in one terminal tab
        jupyter lab --watch
        ```
        
        ### Uninstall
        
        ```bash
        pip uninstall swanintro
        jupyter labextension uninstall @swan-cern/swanintro
        ```
        
Keywords: Jupyter,JupyterLab,SWAN,CERN
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Jupyter
Description-Content-Type: text/markdown
