Package: jupyter-fairly
Jupyter FairlyA jupyterLab extension for thefairlypackage, and the seamless integration of Jupyter-based research environments and research data repositories.This extension is composed of a Python package namedjupyter_fairlyfor the server extension and a NPM package namedjupyter-fairlyfor the frontend extension.RequirementsJupyterLab >= 3.0 < 4fairly >= 0.4.0This is the last version supported by JupyterLab 3.x.InstallTo install the extension, execute:pipinstalljupyter_fairlyConfigurations are stored in.fairly/config.jsonin the user's home directory. This is where the extension stores access tokens for data repositories.To add an access tokens, use theFairlymenu in the JupyterLab main menu bar.UninstallTo remove the extension, execute:pipuninstalljupyter_fairlyTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyter_fairly directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyter_fairly# Rebuild extension Typescript source after making changesjlpmbuildYou 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 extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyter_fairly
pipuninstalljupyter_fairlyIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyter-fairlywithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covjupyter_fairlyFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASECitationPlease cite this software using as follows:Garcia Alvarez, M.,  Girgin, S., & Urra Llanusa, J., Jupyter-fairly: a JupyterLab extension for the fairly pacakage [Computer software]AcknowledgementsThis research is funded by theDutch Research Council (NWO) Open Science Fund, File No. 203.001.114.Project members:Center of Expertise in Big Geodata Science, University of Twente, Faculty ITCDigital Competence Centre, TU Delft4TU.ResearchData