Skip to content

CanDIG/htsget_app

Repository files navigation

Htsget Application

Htsget API implementation that is based on the Htsget retrieval API specifications.

Access to the underlying data objects is mediated through a "baby DRS" server which runs as a separate REST API. The OpenAPI file specifies a suggested format for DRS-compliant genomic variant, read, and index objects. Hopefully a compatible, separate DRS server will be able to implement this API as-is.

Thank you to gel-htsget for being a good starting point to this project

Build Status CodeFactor PyUp

Stack

Installation

The server is meant to be run in the context of the CanDIG stack.

The default MinIO location specified in the config.ini file is the sandbox at MinIO, but a different location can be specified there as well. Be sure to update the access key and secret key values in config.ini.

Testing

An automated test suite is provided, but can only be run in the docker container stack context. If you are running the CanDIG stack, you can run the tests with

docker exec candigv2_htsget_1 pytest

About

Htsget API implementation based on the Htsget protocol

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 15