Skip to main content

GeoSeeq command line tools and python API

Project description

Geoseeq API Client

This package is a python library to interact with a Geoseeq server. It includes a command line interface that may be used to perform common tasks GeoSeeq tasks from the terminal.

GeoSeeq is a platform for sharing biological, climatological, and public health datasets. Learn more here.

This API client is a work in progress and we welcome suggestions, feedback, comments, and criticisms.


Installation

Install from PyPi

pip install geoseeq

Install from source

Download this directory and run python setup.py install


Using the Command Line

Run the command line by typing geoseeq into a terminal prompt. See available options by adding --help

$ geoseeq --help

Configuration and Using an API token

For many tasks you will need an API token to interact with GeoSeeq. You can get this token by logging into the GeoSeeq Portal going to your user profile and clicking the "Tokens" tab.

Once you have a token you will need to configure GeoSeeq to use it. Run geoseeq config and leave the profile name and url blank. You will be prompted to enter your API token.

$ geoseeq config
Set custom profile name? (Leave blank for default) []: 
Enter the URL to use for GeoSeeq (Most users can use the default) [https://backend.geoseeq.com]:
Enter your GeoSeeq API token:
Profile configured.

This command will store your token in a file called ~/.config/geoseeq/profiles.json and will be used by all future commands.

Example Commands

You can find more command line examples in docs/

Download Short Read Sequencing data from one sample in a project as a set of FASTQ files

This command will download data from this project.

$ geoseeq download files --extension fastq.gz "GeoSeeq/Example CLI Project"

Uploading sequencing data

GeoSeeq can automatically group fastq files into samples according to their sample name, read number, and lane number. It supports paired end, single end, and nanopore reads.

Assume you have data from a single ended sequencing run stored as fastq files:

  • Sample1_L1_R1.fastq.gz
  • Sample1_L1_R2.fastq.gz
  • Sample1_L2_R1.fastq.gz
  • Sample1_L2_R2.fastq.gz

You can upload these files to GeoSeeq using the command line. This example will upload 32 files in parallel:

# navigate to the directory where the fastq files are stored
$ ls -1 *.fastq.gz > fastq_files.txt  # check that files are present

$ geoseeq upload reads --cores 32 "GeoSeeq/Example CLI Project" fastq_files.txt
Using regex: "(?P<sample_name>[^_]*)_L(?P<lane_num>[0-9]*)_R(?P<pair_num>1|2)\.fastq\.gz"
All files successfully grouped.
sample_name: Sample1
  module_name: short_read::paired_end
    short_read::paired_end::read_1::lane_1: Sample1_L1_R1.fastq.gz
    short_read::paired_end::read_2::lane_1: Sample1_L1_R2.fastq.gz
    short_read::paired_end::read_1::lane_2: Sample1_L2_R1.fastq.gz
    short_read::paired_end::read_2::lane_2: Sample1_L2_R2.fastq.gz
Do you want to upload these files? [y/N]: y
Uploading Sample: Sample1

GeoSeeq will automatically create a new sample named Sample1 if it does not already exist.

This command would upload data to this project.. Since only organization members can upload data, you will need to replace GeoSeeq with your organization name.

Note: You will need to have an API token set to use this command (see above)

Using the Python API in a program

Please see geoseeq_api/cli/download.py for examples of how to download data using the Python API directly.


Notes

Terminology

Some terms have changed in GeoSeeq since this package was written. The command line tool and code may contain references to old names.

Old Name New Name
Sample Group Project
Library defunct
Analysis Result ResultFolder
Analysis Result Field ResultFile

License and Credits

GeoSeeq is built and maintained by Biotia

The GeoSeeq API client is licensed under the MIT license.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geoseeq-0.6.6a1.tar.gz (76.6 kB view details)

Uploaded Source

Built Distribution

geoseeq-0.6.6a1-py3-none-any.whl (102.2 kB view details)

Uploaded Python 3

File details

Details for the file geoseeq-0.6.6a1.tar.gz.

File metadata

  • Download URL: geoseeq-0.6.6a1.tar.gz
  • Upload date:
  • Size: 76.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.2

File hashes

Hashes for geoseeq-0.6.6a1.tar.gz
Algorithm Hash digest
SHA256 491cd7a573808cb6c0242c061c1e5eb1e4d7a54b587738f9401b84dffbfbef7d
MD5 91647a9e57192c29b65a8e19d7967884
BLAKE2b-256 58303c41eafc4a6cb4de1ca310876e43ebb1519b775b0b9723e80c5cc8845bde

See more details on using hashes here.

File details

Details for the file geoseeq-0.6.6a1-py3-none-any.whl.

File metadata

  • Download URL: geoseeq-0.6.6a1-py3-none-any.whl
  • Upload date:
  • Size: 102.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.2

File hashes

Hashes for geoseeq-0.6.6a1-py3-none-any.whl
Algorithm Hash digest
SHA256 c476b9b90beb784797562d7ab9dffc912e5f88c8e53d77dbee5292cc4b48b0c6
MD5 212ffe19f5e04c6371c5f8c36990e055
BLAKE2b-256 94e4fae8d4ec1d9fa6856400f71e0ac7505cf2bbb92387a37f8ac92fb013e086

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page