Metadata-Version: 2.1
Name: globus_jupyterlab
Version: 1.0.0b2
Summary: JupyterLab extension that incorporates Globus functionality
Home-page: https://github.com/globus/globus-jupyterlab
Author: The Globus Team
License: BSD-3-Clause
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: Programming Language :: Python :: 3.10
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 3
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Requires-Python: >=3.6
Description-Content-Type: text/x-rst

Globus JupyterLab
=================


.. |docs| image:: https://readthedocs.org/projects/globus-jupyterlab/badge/?version=docs
   :target: https://globus-jupyterlab.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://github.com/globus/globus-jupyterlab/actions/workflows/quality.yml/badge.svg
    :target: https://github.com/globus-jupyterlab/globus-jupyterlab/actions/workflows/

.. image:: https://img.shields.io/pypi/v/globus-jupyterlab.svg
    :target: https://pypi.python.org/pypi/globus-jupyterlab

.. image:: https://img.shields.io/pypi/wheel/globus-jupyterlab.svg
    :target: https://pypi.python.org/pypi/globus-jupyterlab

Globus Jupyterlab is an extension to Jupyterlab for easily submitting Globus Transfers
within a running lab environment. Integration within the Jupyterlab filemanager makes
starting transfers just a few clicks away!

Install with the following: 

.. code-block:: bash

    pip install globus-jupyterlab

For information on usage, see the `Read-The-Docs <https://globus-jupyterlab.readthedocs.io/en/main/#>`_.

Developing
----------

For development, use the following instructions: 

.. code-block:: bash

    # install the extension in editable mode
    python -m pip install -e .

    # install your development version of the extension with JupyterLab
    jupyter labextension develop . --overwrite

    # build the TypeScript source after making changes
    jlpm run build

    # start JupyterLab
    jupyter lab


