跳转到主要内容

GA4GH数据对象服务架构

项目描述

数据对象服务(DOS)API的架构


Build Status Swagger Validator Read the Docs badge PyPI - Python Version

在Swagger UI中查看架构

DOS的目标是在现有的对象存储系统之上创建一个通用API,以便工作流程系统可以以单一、标准的方式访问数据,而不管数据存储在哪里。它由GA4GH云工作流维护。

主要功能

API分为两部分

  • 数据对象管理,它能够创建、更新、删除、版本控制和唯一标识文件和数据包(文件平面集合);以及
  • 数据对象查询,可以在不同的云环境和DOS实现中定位数据对象。

入门

安装非常简单

$ pip install ga4gh-dos-schemas

这将安装演示服务器和Python客户端,允许您在本地服务器上管理数据对象。您可以使用ga4gh_dos_server启动演示服务器。这将启动一个数据对象服务在http://localhost:8080

wget http://hgdownload.cse.ucsc.edu/goldenPath/hg38/chromosomes/chr22.fa.gz
md5sum chr22.fa.gz
# 41b47ce1cc21b558409c19b892e1c0d1  chr22.fa.gz
curl -X POST -H 'Content-Type: application/json' \
    --data '{"data_object":
              {"id": "hg38-chr22",
               "name": "Human Reference Chromosome 22",
               "checksums": [{"checksum": "41b47ce1cc21b558409c19b892e1c0d1", "type": "md5"}],
               "urls": [{"url": "http://hgdownload.cse.ucsc.edu/goldenPath/hg38/chromosomes/chr22.fa.gz"}],
               "size": "12255678"}}' http://localhost:8080/ga4gh/dos/v1/dataobjects
# We can then get the newly created Data Object by id
curl http://localhost:8080/ga4gh/dos/v1/dataobjects/hg38-chr22
# Or by checksum!
curl -X GET http://localhost:8080/ga4gh/dos/v1/dataobjects -d checksum=41b47ce1cc21b558409c19b892e1c0d1

有关入门的更多内容,请参阅快速入门指南ReadtheDocs上的其他文档!

参与进来!

数据对象服务架构是Apache 2许可的开源软件。请加入我们讨论问题或查看贡献文档!

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

ga4gh_dos_schemas-0.4.2.tar.gz (19.0 kB 查看散列值)

上传时间

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面