Skip to main content

可用于调用 BGE 开放平台的相关接口。

Project description

BGE 开放平台 SDK - Python 版

GitHub forks GitHub forks GitHub forks

GitHub release (latest by date) GitHub top language GitHub code size in bytes GitHub commit activity PyPI - Downloads

    ____  ____________   ______  __________  ______  _   __   _____ ____  __ __
   / __ )/ ____/ ____/  / __ \ \/ /_  __/ / / / __ \/ | / /  / ___// __ \/ //_/
  / __  / / __/ __/    / /_/ /\  / / / / /_/ / / / /  |/ /   \__ \/ / / / ,<   
 / /_/ / /_/ / /___   / ____/ / / / / / __  / /_/ / /|  /   ___/ / /_/ / /| |  
/_____/\____/_____/  /_/     /_/ /_/ /_/ /_/\____/_/ |_/   /____/_____/_/ |_| 

BGE 开放平台 是一个跨越多级数据的(多)组学数据平台,开发者在获得用户授权后,将可以通过开放平台提供的 API 访问关联用户的(多)组学数据,甚至写入数据。

基于开放平台 API,开发者可避免重复开发采样、提取、测序和生信分析等繁复的流程,直接使用清洁的结构化数据。

开发者可以通过开放平台提供的 API 创建极具创意性的(多)组学应用,如:

  • 包含药物代谢或药物服用建议的应用
  • 包含体检数据和营养代谢基因的餐饮应用
  • 包含肠道菌群数据和痛风相关基因的痛风管理应用
  • 基于祖源成分的社交网络应用,等等

BGE 开放平台 API 基于 OAuth 2.0 开发,并使用 SSL/TLS 加密传输,确保用户数据正确无误地授权,并安全地传输到第三方应用,确保用户数据不会被未经授权的应用获得。

安装

推荐使用 pip 进行安装。

$ pip install bge-python-sdk

或者

$ make install

再或者

$ python setup.py install

SDK 文档

更加详细的 SDK 文档请查看 SDK Documents

快速开始

BGE 开放平台支持 OAuth2 的两种模式,分别是用户授权模式、客户端模式。

详情请参考开放平台文档 https://api.bge.genomics.cn/doc

授权码模式

from bgesdk import OAuth2, API

code = '???????'  # 用户确认授权后平台返回的授权码
client_id = 'demo'
client_secret = 'demo'
redirect_uri = 'http://test.cn'
oauth2 = OAuth2(client_id, client_secret)
token = oauth2.exchange_authorization_code(code, redirect_uri)

api = oauth2.get_api(token.access_token)
print(api.get_user())

api = API(token.access_token)
print(api.get_user())

客户端模式

from bgesdk import OAuth2, API

client_id = 'demo'
client_secret = 'demo'
oauth2 = OAuth2(client_id, client_secret)
token = oauth2.get_credentials_token()

api = oauth2.get_api(token.access_token)
print(api.get_variants('E-B1243433', 'rs333'))

api = API(token.access_token)
print(api.get_variants('E-B1243433', 'rs333'))

Contributors

Project details


Download files

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

Source Distribution

bge-python-sdk-0.1b1.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bge_python_sdk-0.1b1-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file bge-python-sdk-0.1b1.tar.gz.

File metadata

  • Download URL: bge-python-sdk-0.1b1.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.5

File hashes

Hashes for bge-python-sdk-0.1b1.tar.gz
Algorithm Hash digest
SHA256 7616ea73937a98808c9d66f743835dfb4c06e5495ec4c13805673787b4a5c4cc
MD5 79380c4f34d1a8bee4e4944d986e6a85
BLAKE2b-256 f2281fe0653506b4e2c3fdb72e47845e95441395f87c2ecf1b11ec4c437fc94f

See more details on using hashes here.

File details

Details for the file bge_python_sdk-0.1b1-py3-none-any.whl.

File metadata

  • Download URL: bge_python_sdk-0.1b1-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.5

File hashes

Hashes for bge_python_sdk-0.1b1-py3-none-any.whl
Algorithm Hash digest
SHA256 c6c2850e7a49dcad8c8663a17220b0df7574d7415656fe7470714a0f2bba0ab8
MD5 d24c9a4c5a078b0ab64cdfa175048daf
BLAKE2b-256 dd39c0d13bb3d6056937c56c92f9356c369215f056a91cdbe004d1434be49967

See more details on using hashes here.

Supported by

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