Metadata-Version: 2.1
Name: sonivis_lens_widget
Version: 0.1.4.dev0
Summary: jupyter notebook widget with a scatter plot and an interactive lens
Home-page: https://github.com/fhstp/sonivis-lens-widget
Author: Alexander Rind & the SoniVis team
Author-email: 
License: MIT
Description: 
        # sonivis-lens-widget
        
        [![Build Status](https://travis-ci.org/fhstp/sonivis-lens-widget.svg?branch=master)](https://travis-ci.org/fhstp/sonivis_lens_widget)
        [![codecov](https://codecov.io/gh/fhstp/sonivis-lens-widget/branch/master/graph/badge.svg)](https://codecov.io/gh/fhstp/sonivis-lens-widget)
        
        
        jupyter notebook widget with a scatter plot and an interactive lens
        
        ## Installation
        
        You can install using `pip`:
        
        ```bash
        pip install sonivis_lens_widget
        ```
        
        If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
        the nbextension:
        ```bash
        jupyter nbextension enable --py [--sys-prefix|--user|--system] sonivis_lens_widget
        ```
        
        You can upgrade using `pip`:
        
        ```bash
        pip install sonivis_lens_widget --upgrade --upgrade-strategy only-if-needed
        ```
        
        ## Development Installation
        
        Create a dev environment:
        ```bash
        conda create -n sonivis_lens_widget-dev -c conda-forge nodejs yarn python jupyterlab
        conda activate sonivis_lens_widget-dev
        ```
        or
        ```bash
        python -m venv venv
        source venv/Scripts/activate
        pip install nodejs jupyterlab jupyter-packaging
        ```
        
        Install the python. This will also build the TS package.
        ```bash
        pip install -e ".[test, examples]"
        ```
        
        When developing your extensions, you need to manually enable your extensions with the
        notebook / lab frontend. For lab, this is done by the command:
        
        ```
        jupyter labextension develop --overwrite .
        npm run build
        ```
        
        For classic notebook, you need to run:
        
        ```
        jupyter nbextension install --sys-prefix --symlink --overwrite --py sonivis_lens_widget
        jupyter nbextension enable --sys-prefix --py sonivis_lens_widget
        ```
        
        Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
        the `install` command every time that you rebuild your extension. For certain installations
        you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
        of those flags here.
        
        To use symlinks in Windows 10, you can turn on Windows' developer mode.
        
        ### How to see your changes
        #### Typescript:
        If you use JupyterLab to develop then 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 widget.
        
        ```bash
        # Watch the source directory in one terminal, automatically rebuilding when needed
        npm run watch
        # Run JupyterLab in another terminal
        jupyter lab
        ```
        
        After a change wait for the build to finish and then refresh your browser and the changes should take effect.
        
        #### Python:
        If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
        
Keywords: Jupyter,Widgets,IPython
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: Jupyter
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: examples
Provides-Extra: docs
