Metadata-Version: 2.1
Name: glab
Version: 0.1.0
Summary: An online genealogy program built from Jupyter and Gramps
Home-page: https://github.com/GenealogyCollective/glab
Author: Douglas Blank
License: BSD-3-Clause
Description: # glab
        
        An online genealogy program built on top of Jupyter and Gramps.
        
        
        This extension is composed of a Python package named `glab`
        for the server extension and a NPM package named `glab`
        for the frontend extension.
        
        
        ## Requirements
        
        * JupyterLab >= 2.0
        
        ## Install
        
        Note: You will need NodeJS to install the extension.
        
        ```bash
        pip install glab
        jupyter lab build
        ```
        
        ## Troubleshoot
        
        If you are seeing the frontend extension but it is not working, check
        that the server extension is enabled:
        
        ```bash
        jupyter serverextension list
        ```
        
        If the server extension is installed and enabled but you are not seeing
        the frontend, check the frontend is 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 glab directory
        
        # Install server extension
        pip install -e . --prefix=~/.local/
        # Register server extension
        jupyter serverextension enable --py glab --user
        # Check to see if it is installed:
        jupyter serverextension list
        
        # Install dependencies
        jlpm
        # Build Typescript source
        jlpm build
        # Link your development version of the extension with JupyterLab
        jupyter labextension install .
        # Check to see if it is installed:
        jupyter labextension list
        
        # 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
        ```
        
        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).
        
        ### Uninstall
        
        ```bash
        pip uninstall glab
        jupyter labextension uninstall glab
        ```
        
Keywords: Jupyter,JupyterLab
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.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
