hubmap-clt 1.0.0

A command line interface to download multiple files and directories from Globus file transfer service using a manifest file.

hubmap-clt

---

A command line interface to download multiple files and directories from the Globus file transfer service.

Overview

The HuBMAP Command-Line Transfer uses the Globus cli to transfer files from a manifest file. This file contains the ID (UUID or HuBMAP ID) and the path to the specific file or directory to be downloaded.

Installing and Using hubmap-clt

The HuBMAP Command-Line Transfer requires a local Globus Connect Personal Endpoint to be connected. The user must have an account with Globus and be logged into both the local endpoint as well as the Globus command line interface. Hubmap-clt is available through PyPi and can be installed with:

pip3 hubmap-clt

hubmap-clt requirements can be found here

Consult Installing hubmap-clt and Consult Using hubmap-clt for full documentation on getting started with hubmap-clt as we as information on the required Globus software.

Building and Publishing hubmap-clt

SetupTools and Wheel is required to build the clt distribution. Twine is required to publish to Pypi

Build the distribution directory with:

python3 setup.py sdist bdist_wheel

from within the hubmap-clt project directory

To publish, from inside the project directory, run:

twine upload dist/*

A prompt to enter login information to the hubmap Pypi account will appear

Files

This code contains:

__main__.py: Contains the implementation of the command-line interface as well as the logic for the clt.

Inside of __main__.py are the following classes:

• whoami: Informs the user if they are logged into Globus
• login: Initiates a Globus login using the default web browser
• transfer: Sets up a transfer into the user's downloads file. Accepts a single required argument. This argument is the name of a manifest file which contains information on the files to be downloaded
• batch_transfer: Calls globus batch transfer for each source collection represented in the manifest file.