Skip to main content

HTTP SDK for querying pipeline data service

Project description

pipeline-http-sdk

定位

pipeline-http-sdkpipeline-http-service 的 Python 客户端,提供接近 Tushare 的调用体验,返回 pandas.DataFrame

安装

pip install pipeline-http-sdk

快速开始

import pipeline_sdk as ts

ts.set_token("your-token")
pro = ts.pro_api()

df = pro.stock_basic(
    fields="ts_code,name,list_date",
    order_by="list_date",
    sort="desc",
    limit=20,
)
print(df.head())

核心接口

统一查询:

df = pro.query(
    "stock_basic",
    ts_code="000001.SZ",
    fields=["ts_code", "name", "list_date"],
    order_by="list_date",
    sort="desc",
    limit=200,
    offset=0,
)

动态方法(等价于 query):

df = pro.stock_basic(ts_code="000001.SZ", limit=50)

获取 API 列表:

apis = pro.list_apis(enabled_only=True)

核心能力

  • set_token() + pro_api() 初始化
  • pro.query(...) 统一查询
  • pro.xxx(...) 动态 API 调用
  • pro.list_apis(...) 拉取可用接口

参数约定

  • 支持普通参数和列表参数
  • 支持分页:limit / offset
  • 支持排序:order_by / sortascdesc
  • 参数语义由服务端解释

异常处理

HTTP 或业务错误会抛出 PipelineSDKError

from pipeline_sdk import PipelineSDKError

try:
    df = pro.query("stock_basic", limit=10)
except PipelineSDKError as exc:
    print("message:", exc)
    print("code:", exc.code)
    print("detail:", exc.detail)

常见错误消息:

  • unauthorized(401)
  • 其它服务端 message(统一透传)

开发与发布

python -m pip install --upgrade build twine
python -m build
python -m twine check dist/*

更多发布步骤:docs/PYPI_PUBLISH.md

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

pipeline_http_sdk-0.1.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

pipeline_http_sdk-0.1.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file pipeline_http_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: pipeline_http_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for pipeline_http_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 9e917400af7b007bb3baa69f31b8f3c289844e7e49b9c39b20d283438eb5777a
MD5 031d5eb7ebcaad9fa75066c90c1a1f2e
BLAKE2b-256 d757898f3415fdd00d404551b14b5b4b34dd76e28b00262a655bbfcd2e3b530a

See more details on using hashes here.

File details

Details for the file pipeline_http_sdk-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pipeline_http_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ce0a61ec0740a03b425146c3906805fe6275641df1de69c5024b48ca2077013
MD5 e19cf552d4e086a212b3214ce89cd385
BLAKE2b-256 5be5659e5fc093960010bf941502f79206724efdfd015cd190e1d61ba4492ca6

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