Metadata-Version: 2.1
Name: jupyterlab-topbar
Version: 0.6.0
Summary: JupyterLab extension to expose the top bar space
Home-page: https://github.com/jtpio/jupyterlab-topbar.git
Author: Jeremy Tuloup
License: BSD-3-Clause
Description: # JupyterLab Top Bar
        
        ![Github Actions Status](https://github.com/jtpio/jupyterlab-topbar/workflows/Build/badge.svg)
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jtpio/jupyterlab-topbar/stable?urlpath=lab)
        
        Monorepo to experiment with the top bar space in JupyterLab.
        
        Similar to the [status bar](https://github.com/jupyterlab/jupyterlab/tree/master/packages/statusbar-extension), the top bar can be used to place a few indicators and optimize the overall space.
        
        Inspired by Gnome Shell Top Bar indicators.
        
        ![screencast](./doc/screencast.gif)
        
        ### Extensions
        
        - [jupyterlab-topbar-extension](./packages/jupyterlab-topbar-extension): generic extension to expose the top bar area
        - [jupyterlab-topbar-text](./packages/jupyterlab-topbar-text): add and edit custom text
        - [jupyterlab-system-monitor](https://github.com/jtpio/jupyterlab-system-monitor): show system metrics (memory usage)
        - [jupyterlab-logout](https://github.com/jtpio/jupyterlab-logout): add a "Log Out" button
        - [jupyterlab-theme-toggle](https://github.com/jtpio/jupyterlab-theme-toggle): switch between the Light and Dark themes
        
        ## Try it online
        
        Try the extensions in your browser with Binder:
        
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jtpio/jupyterlab-topbar/stable?urlpath=lab)
        
        ## Installation
        
        ### JupyterLab 3.0
        
        ```bash
        # container extension
        pip install jupyterlab-topbar
        
        # to install the topbar-text extension
        jupyter labextension install jupyterlab-topbar-text
        ```
        
        ### JupyterLab 1.x and 2.x
        
        ```bash
        # container extension
        jupyter labextension install jupyterlab-topbar-extension
        
        # system metrics
        jupyter labextension install jupyterlab-system-monitor
        pip install nbresuse
        
        # custom text in the top bar
        jupyter labextension install jupyterlab-topbar-text
        
        # add a logout button
        jupyter labextension install jupyterlab-logout
        
        # theme toggling extension
        jupyter labextension install jupyterlab-theme-toggle
        ```
        
        All-in-one install:
        
        ```bash
        jupyter labextension install jupyterlab-topbar-extension \
                                     jupyterlab-system-monitor \
                                     jupyterlab-topbar-text \
                                     jupyterlab-logout \
                                     jupyterlab-theme-toggle
        ```
        
        ## Development
        
        ```bash
        # create a new conda environment
        conda create -n jupyterlab-topbar -c conda-forge jupyterlab nodejs -y
        conda activate jupyterlab-topbar
        
        # Install dependencies
        jlpm
        
        # Install the package in development mode
        pip install -e .
        
        # Link your development version of the extension with JupyterLab
        jlpm run develop
        
        # For the jupyterlab-topbar-text extension
        jlpm run link
        
        # Rebuild extension TypeScript source after making changes
        jlpm run build
        ```
        
        ### Uninstall
        
        ```bash
        pip uninstall jupyterlab-topbar
        ```
        
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.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
