| Name | tushare-interface JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | An interface encapsulated based on Tushare, which implements rate limiting and retry mechanisms. |
| upload_time | 2024-04-11 16:48:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
tushare
stock
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tushare-interface
将tushare接口封装在类中，并提供限流、重试功能
#### 安装教程
1. pip install tushare-interface
2. 在.bashrc中添加环境变量：
- export TUSHARE_TOKEN='xxxxxxxxxx' 该api从tushare.pro网站购买
- export TUSHARE_POINTS='120', 设置你的实际积分，将据此设定每分钟可访问接口的次数，需要注意的是，与网站上说明的不同，120积分实际只支持10次查询/分钟
#### 使用说明
1. from tushare_interface import interfaceTuShare as pro
2. package内有实例化对象: interfaceTuShare,
- 如果环境变量已经设置好，import后即可使用
- 如果环境变量未设置，可通过setToken函数设置从htp://tushare.pro获得的token; 以及
- 通过setPoints函数设置积分，最低120
3. interfaceTuShare还可以使用setRetry设置重试次数（最少0次）和重试间隔（以秒为单位，最低1秒）
4. 如果发现请求后出现流控告警，可以通过setTimesPerMinutus直接设置每分钟发送请求的数量，最低1次/分钟。
5. 调用query接口从tushare下载数据，接口与tushare原始的query保持一致
6. 函数原型
- setToken(self, token: str) -> None
- setPoints(self, points: int) -> None:
- setTimesPerMinutus(self, timesPerMinutus: int) -> None
- setRetry(self, retrys: int, secondsWaitRetry: int) -> None
- query(self, func_name: str, **kwds: object) -> pandas.DataFrame | None
Raw data
{
"_id": null,
"home_page": null,
"name": "tushare-interface",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "tushare, stock",
"author": null,
"author_email": "polaritec <yuan.xin@polaritec.com>",
"download_url": "https://files.pythonhosted.org/packages/d4/17/dbff674eb32109356ca06261d329a0d3821f75351baecde05dc88eb1ad50/tushare_interface-0.2.0.tar.gz",
"platform": null,
"description": "# tushare-interface\n\u5c06tushare\u63a5\u53e3\u5c01\u88c5\u5728\u7c7b\u4e2d\uff0c\u5e76\u63d0\u4f9b\u9650\u6d41\u3001\u91cd\u8bd5\u529f\u80fd\n\n#### \u5b89\u88c5\u6559\u7a0b\n1. pip install tushare-interface\n2. \u5728.bashrc\u4e2d\u6dfb\u52a0\u73af\u5883\u53d8\u91cf\uff1a\n- export TUSHARE_TOKEN='xxxxxxxxxx' \u8be5api\u4ecetushare.pro\u7f51\u7ad9\u8d2d\u4e70\n- export TUSHARE_POINTS='120', \u8bbe\u7f6e\u4f60\u7684\u5b9e\u9645\u79ef\u5206\uff0c\u5c06\u636e\u6b64\u8bbe\u5b9a\u6bcf\u5206\u949f\u53ef\u8bbf\u95ee\u63a5\u53e3\u7684\u6b21\u6570\uff0c\u9700\u8981\u6ce8\u610f\u7684\u662f\uff0c\u4e0e\u7f51\u7ad9\u4e0a\u8bf4\u660e\u7684\u4e0d\u540c\uff0c120\u79ef\u5206\u5b9e\u9645\u53ea\u652f\u630110\u6b21\u67e5\u8be2/\u5206\u949f\n\n#### \u4f7f\u7528\u8bf4\u660e\n\n1. from tushare_interface import interfaceTuShare as pro\n2. package\u5185\u6709\u5b9e\u4f8b\u5316\u5bf9\u8c61: interfaceTuShare, \n- \u5982\u679c\u73af\u5883\u53d8\u91cf\u5df2\u7ecf\u8bbe\u7f6e\u597d\uff0cimport\u540e\u5373\u53ef\u4f7f\u7528\n- \u5982\u679c\u73af\u5883\u53d8\u91cf\u672a\u8bbe\u7f6e\uff0c\u53ef\u901a\u8fc7setToken\u51fd\u6570\u8bbe\u7f6e\u4ecehtp://tushare.pro\u83b7\u5f97\u7684token; \u4ee5\u53ca\n- \u901a\u8fc7setPoints\u51fd\u6570\u8bbe\u7f6e\u79ef\u5206\uff0c\u6700\u4f4e120\n3. interfaceTuShare\u8fd8\u53ef\u4ee5\u4f7f\u7528setRetry\u8bbe\u7f6e\u91cd\u8bd5\u6b21\u6570\uff08\u6700\u5c110\u6b21\uff09\u548c\u91cd\u8bd5\u95f4\u9694\uff08\u4ee5\u79d2\u4e3a\u5355\u4f4d\uff0c\u6700\u4f4e1\u79d2\uff09\n4. \u5982\u679c\u53d1\u73b0\u8bf7\u6c42\u540e\u51fa\u73b0\u6d41\u63a7\u544a\u8b66\uff0c\u53ef\u4ee5\u901a\u8fc7setTimesPerMinutus\u76f4\u63a5\u8bbe\u7f6e\u6bcf\u5206\u949f\u53d1\u9001\u8bf7\u6c42\u7684\u6570\u91cf\uff0c\u6700\u4f4e1\u6b21/\u5206\u949f\u3002\n5. \u8c03\u7528query\u63a5\u53e3\u4ecetushare\u4e0b\u8f7d\u6570\u636e\uff0c\u63a5\u53e3\u4e0etushare\u539f\u59cb\u7684query\u4fdd\u6301\u4e00\u81f4\n6. \u51fd\u6570\u539f\u578b\n- setToken(self, token: str) -> None\n- setPoints(self, points: int) -> None:\n- setTimesPerMinutus(self, timesPerMinutus: int) -> None\n- setRetry(self, retrys: int, secondsWaitRetry: int) -> None\n- query(self, func_name: str, **kwds: object) -> pandas.DataFrame | None\n",
"bugtrack_url": null,
"license": null,
"summary": "An interface encapsulated based on Tushare, which implements rate limiting and retry mechanisms.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/polaritec/tushare-interface"
},
"split_keywords": [
"tushare",
" stock"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3ce7c727787a06dd5e7fd483ba416ec3225b1daf33811a85fd4283a846e3780",
"md5": "7469a8aadb705ab59d2e27fe3303c7a2",
"sha256": "f16a5e2c0af743db74d279887d8f71aa26699a981b391810864827dca5d7f0a2"
},
"downloads": -1,
"filename": "tushare_interface-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7469a8aadb705ab59d2e27fe3303c7a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9015,
"upload_time": "2024-04-11T16:48:20",
"upload_time_iso_8601": "2024-04-11T16:48:20.153320Z",
"url": "https://files.pythonhosted.org/packages/f3/ce/7c727787a06dd5e7fd483ba416ec3225b1daf33811a85fd4283a846e3780/tushare_interface-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d417dbff674eb32109356ca06261d329a0d3821f75351baecde05dc88eb1ad50",
"md5": "b91da32b4c867f44bb1b0298173ffe01",
"sha256": "642825f9dcd0ddf25f8f61145538f6f1c0866fae68e3cab0dae4a2fb287d8c2e"
},
"downloads": -1,
"filename": "tushare_interface-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "b91da32b4c867f44bb1b0298173ffe01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 9551,
"upload_time": "2024-04-11T16:48:21",
"upload_time_iso_8601": "2024-04-11T16:48:21.899882Z",
"url": "https://files.pythonhosted.org/packages/d4/17/dbff674eb32109356ca06261d329a0d3821f75351baecde05dc88eb1ad50/tushare_interface-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 16:48:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "polaritec",
"github_project": "tushare-interface",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tushare-interface"
}
