gsport 2.0.0

Download manager for genomscan portal

GSport

GSport is a command-line tool designed to accelerate file downloads from the GenomeScan Customer Portal. It leverages multiprocessing to significantly improve download speeds and efficiency. Works on linux, windows and macOS.

WARNING: This is version 2.0, some of the command line interface has changed partially in preparation for version 3.0 that will be released (hopefully end of 2025) when we start using our new customer portal. Verion 1.x should still be usable during version 2.0, but when version 3.0 is introduced both version 1 and 2 will no longer work.

Prerequisites

Ensure you have the following installed:

• Python 3.8.X
• Pip (Python package manager)
• python-venv (Linux/ macOS) or virtualenv(windows)

Installation

There are 2 options for installing GSport.

• Pip install
• Manual installation

Pip install

pip install gsport

Manual install

Linux/macOS

git clone https://github.com/genomescan/gsport.git
cd gsport
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

Windows

git clone https://github.com/genomescan/gsport.git
cd gsport
virtualenv env
env\Scripts\activate.bat
pip install -r requirements.txt

Usage

To see all available options, run:

python gsport.py --help

This will print a full list of available options and flags.

List Files

gsport list 100000
gsport list 100000 -m
gsport list 100000 -d directory
gsport list 100000 -m -d directory
gsport list 100000 -r
gsport list 100000 -r -d directory

Download All Files

gsport all 100000
gsport all 100000 -d directory
gsport all 100000 -r
gsport all 100000 -r -d directory
gsport all 100000 -o outputdir

Download Specific Files

gsport download 100000 path/to/file1.txt path/to/file2.txt
gsport download 100000 path/to/file.txt -o outputdir

Advanced Examples

gsport -p 100000 -l                        # List all files in the project
gsport -p 100000 -ls                       # List files with size
gsport -p 100000 -l --dirs                 # List only folders/directories
gsport -p 100000 -l --cd Analysis          # List files under "Analysis"
gsport -p 100000 -l -r                     # List all in a recursive tree
gsport -p 100000 -l --dirs --cd Analysis   # List folders under Analysis