sharetop 0.1.0__tar.gz

sharetop-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 ShareTop Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sharetop-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+include sharetop/py.typed
+recursive-include sharetop *.pyi

sharetop-0.1.0/PKG-INFO

@@ -0,0 +1,287 @@
+Metadata-Version: 2.4
+Name: sharetop
+Version: 0.1.0
+Summary: ShareTop Python Client
+Author-email: ShareTop Team <support@sharetop.top>
+License: MIT
+Project-URL: Documentation, https://docs.sharetop.top
+Project-URL: Repository, https://github.com/sharetop-org/sharetop
+Keywords: finance,stock,market-data,trading,api-client
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: pandas>=1.5.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: tqdm>=4.60.0
+Provides-Extra: gevent
+Requires-Dist: gevent>=23.0.0; extra == "gevent"
+Provides-Extra: full
+Requires-Dist: sharetop[gevent]; extra == "full"
+Dynamic: license-file
+
+# ShareTop Python SDK
+
+[![Python Version](https://img.shields.io/badge/python-3.9+-blue.svg?style=flat)](https://pypi.org/project/sharetop/)
+[![PyPI Package](https://img.shields.io/pypi/v/sharetop.svg?maxAge=60)](https://pypi.org/project/sharetop/)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/sharetop.svg?maxAge=2592000&label=downloads&color=%2327B1FF)](https://pypi.org/project/sharetop/)
+[![Docs](https://img.shields.io/badge/docs-docs.sharetop.org-blue)](https://docs.sharetop.org)
+[![GitHub Stars](https://img.shields.io/github/stars/sharetop-org/sharetop.svg?style=social&label=Star&maxAge=60)](https://github.com/sharetop-org/sharetop)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+
+凡是数据皆有价值，前提是要放到正确位置，同时在正确的时间被使用。
+
+ShareTop 是一个开源数据社区，主要为个人及科研团队在金融、宏观、汽车、石油等领域的科学研究提供数据清洗、结构化的API接口服务，它不以盈利为主要目的，不做任何荐股或者推荐。
+
+ShareTop Python SDK 是 ShareTop 数据长期维护的 Python 客户端，提供 金融、宏观、汽车等相关行业存量和增量数据。
+
+“数据仅供参考，不构成投资建议”
+
+> **完整文档**：<https://sharetop.top>
+
+---
+
+## 安装
+
+使用 pip 安装 ShareTop Python SDK：
+
+```bash
+pip install sharetop
+```
+
+SDK 支持 Python 3.9+，推荐使用 Python 3.10 或更高版本。
+
+---
+
+## 获取token
+
+
+### 关注公众号并点击获取token
+
+<img src="img/scan.png" alt="微信公众号二维码" width="300">
+
+
+## 初始化客户端
+
+### 免费服务
+
+如果你只需要日K线数据和股票基础信息，可以直接使用免费服务：
+
+```python
+from sharetop import ShareTop
+
+# 从微信公众号里面获取token
+token = ""
+
+client = ShareTop(token=token)
+
+# 查询日K线数据
+symbol = "601717.SH"
+
+df = client.klines.get_history_data(symbol=symbol, count=500000, period="d", adjust="before", as_df=True)
+print(df)
+```
+
+**免费服务特点：**
+- ✅ 关注微信公众号，获取token，直接使用
+- ✅ 提供历史日K线数据（d、w、m、q、y）
+- ✅ 提供标的信息、交易所、标的池查询
+- ❌ 不提供实时行情
+- ❌ 不提供分钟级K线（1m、5m、15m、30m、60m、120m）
+- ⚠️ 日K数据为历史数据，盘中不会实时更新
+
+如果你需要实时行情、盘中实时更新的K线或更高频率访问，请使用完整服务。
+
+---
+
+### 完整服务
+
+```python
+from sharetop import ShareTop
+
+# 从微信公众号里面获取token
+token = ""
+
+client = ShareTop(token=token)
+
+# 获取沪深 A 股实时行情
+df = client.quotes.get(symbols="600000.SH,002522.SZ,000006.SZ,688003.SH,002534.SZ", as_df=True)
+
+print(df)
+```
+
+如果看到股票价格输出，说明 SDK 已配置成功！
+
+**完整服务优势：**
+- ✅ 实时行情数据
+- ✅ 分钟级K线（5m、15m、30m、60m、120m）
+- ✅ 日内分时数据
+- ✅ 财报数据
+- ✅ 更高的调用频率
+- ✅ 打板专题数据
+
+---
+
+## 标的代码格式与支持市场
+
+所有按标的查询的接口（行情、K 线等）均使用**统一标的代码**，格式为：**`代码.市场后缀`**（中间为英文点号）。
+
+### 标的代码格式
+
+- 格式：`代码.市场后缀`
+- 示例：
+  - 股票：`600000.SH`（浦发银行）、`000001.SZ`（平安银行）、`920662.BJ`（方盛股份）
+
+代码部分使用交易所官方代码（如 6 位 A 股代码、合约代码等），**市场后缀**见下表。
+
+### 支持的市场（后缀）
+
+| 后缀 | 市场 | 说明 |
+|------|------|------|
+| **SH** | 上海证券交易所 | 沪市 A 股、ETF、债券等 |
+| **SZ** | 深圳证券交易所 | 深市 A 股、创业板、ETF 等 |
+| **BJ** | 北京证券交易所 | 北交所股票 |
+
+### 目前支持状态
+
+- **A 股（SH / SZ / BJ）**：已支持。可查实时行情、日 K、分钟 K、日内分时、财务数据等。
+
+按标的查询时传入上述格式的字符串或列表即可：
+
+```python
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+# 上交所整体实时数据
+df = client.quotes.get(exchange=["SSE"], as_df=True)
+
+print(df)
+```
+
+---
+
+## 基础用法
+
+### K 线获取
+
+**单个或者批量获取分钟k线**：
+
+```python
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+symbols = ["601717.SH", "601928.SH"]
+
+# 获取分钟 K 线，返回原始数据
+kline_data = client.klines.get_batch_real_time(symbols=symbols, period="1m", count=5, adjust="before", as_df=True)
+print(f"601717.SH最新的1min k线数据: {kline_data['601717.SH']}")
+
+```
+
+### 获取实时行情
+
+**按标的代码查询**
+
+```python
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+symbols = ["600000.SH", "002534.SZ", "688003.SH"]
+
+df = client.quotes.get(symbols=symbols, as_df=True)
+
+print(df)
+```
+
+**按标的池查询**
+
+```python
+# 获取全部 上交所 A 股行情
+quotes_a = client.quotes.get(exchange=["SSE"], as_df=True)
+
+print(quotes_a)
+
+
+# 获取全部 上交所 深交所 A 股行情
+quotes = client.quotes.get(exchange=["SSE", "SZSE"], as_df=True)
+
+print(quotes)
+
+```
+
+### 获取打板数据
+
+**炸板池查询**
+
+```python
+
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+# 获取实时炸板池数据
+df = client.limit_up.limit_up_down_pool.broken_limit(as_df=True)
+
+print(df)
+
+```
+
+**强势股池查询**
+
+```python
+
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+# 获取实时强势股池数据
+df = client.limit_up.limit_up_down_pool.strong(as_df=True)
+
+print(df)
+
+```
+
+---
+
+## 更多文档
+
+- [完整示例](https://docs.tickflow.org/zh-Hans/sdk/python-examples) — 查看更多使用场景和代码示例
+- [最佳实践](https://docs.tickflow.org/zh-Hans/sdk/python-best-practices) — 了解生产环境的最佳实践
+- [API 参考](https://docs.tickflow.org/zh-Hans/api-reference/introduction) — HTTP API 接口说明
+
+---
+
+## License
+
+MIT

sharetop-0.1.0/README.md

@@ -0,0 +1,248 @@
+# ShareTop Python SDK
+
+[![Python Version](https://img.shields.io/badge/python-3.9+-blue.svg?style=flat)](https://pypi.org/project/sharetop/)
+[![PyPI Package](https://img.shields.io/pypi/v/sharetop.svg?maxAge=60)](https://pypi.org/project/sharetop/)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/sharetop.svg?maxAge=2592000&label=downloads&color=%2327B1FF)](https://pypi.org/project/sharetop/)
+[![Docs](https://img.shields.io/badge/docs-docs.sharetop.org-blue)](https://docs.sharetop.org)
+[![GitHub Stars](https://img.shields.io/github/stars/sharetop-org/sharetop.svg?style=social&label=Star&maxAge=60)](https://github.com/sharetop-org/sharetop)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+
+凡是数据皆有价值，前提是要放到正确位置，同时在正确的时间被使用。
+
+ShareTop 是一个开源数据社区，主要为个人及科研团队在金融、宏观、汽车、石油等领域的科学研究提供数据清洗、结构化的API接口服务，它不以盈利为主要目的，不做任何荐股或者推荐。
+
+ShareTop Python SDK 是 ShareTop 数据长期维护的 Python 客户端，提供 金融、宏观、汽车等相关行业存量和增量数据。
+
+“数据仅供参考，不构成投资建议”
+
+> **完整文档**：<https://sharetop.top>
+
+---
+
+## 安装
+
+使用 pip 安装 ShareTop Python SDK：
+
+```bash
+pip install sharetop
+```
+
+SDK 支持 Python 3.9+，推荐使用 Python 3.10 或更高版本。
+
+---
+
+## 获取token
+
+
+### 关注公众号并点击获取token
+
+<img src="img/scan.png" alt="微信公众号二维码" width="300">
+
+
+## 初始化客户端
+
+### 免费服务
+
+如果你只需要日K线数据和股票基础信息，可以直接使用免费服务：
+
+```python
+from sharetop import ShareTop
+
+# 从微信公众号里面获取token
+token = ""
+
+client = ShareTop(token=token)
+
+# 查询日K线数据
+symbol = "601717.SH"
+
+df = client.klines.get_history_data(symbol=symbol, count=500000, period="d", adjust="before", as_df=True)
+print(df)
+```
+
+**免费服务特点：**
+- ✅ 关注微信公众号，获取token，直接使用
+- ✅ 提供历史日K线数据（d、w、m、q、y）
+- ✅ 提供标的信息、交易所、标的池查询
+- ❌ 不提供实时行情
+- ❌ 不提供分钟级K线（1m、5m、15m、30m、60m、120m）
+- ⚠️ 日K数据为历史数据，盘中不会实时更新
+
+如果你需要实时行情、盘中实时更新的K线或更高频率访问，请使用完整服务。
+
+---
+
+### 完整服务
+
+```python
+from sharetop import ShareTop
+
+# 从微信公众号里面获取token
+token = ""
+
+client = ShareTop(token=token)
+
+# 获取沪深 A 股实时行情
+df = client.quotes.get(symbols="600000.SH,002522.SZ,000006.SZ,688003.SH,002534.SZ", as_df=True)
+
+print(df)
+```
+
+如果看到股票价格输出，说明 SDK 已配置成功！
+
+**完整服务优势：**
+- ✅ 实时行情数据
+- ✅ 分钟级K线（5m、15m、30m、60m、120m）
+- ✅ 日内分时数据
+- ✅ 财报数据
+- ✅ 更高的调用频率
+- ✅ 打板专题数据
+
+---
+
+## 标的代码格式与支持市场
+
+所有按标的查询的接口（行情、K 线等）均使用**统一标的代码**，格式为：**`代码.市场后缀`**（中间为英文点号）。
+
+### 标的代码格式
+
+- 格式：`代码.市场后缀`
+- 示例：
+  - 股票：`600000.SH`（浦发银行）、`000001.SZ`（平安银行）、`920662.BJ`（方盛股份）
+
+代码部分使用交易所官方代码（如 6 位 A 股代码、合约代码等），**市场后缀**见下表。
+
+### 支持的市场（后缀）
+
+| 后缀 | 市场 | 说明 |
+|------|------|------|
+| **SH** | 上海证券交易所 | 沪市 A 股、ETF、债券等 |
+| **SZ** | 深圳证券交易所 | 深市 A 股、创业板、ETF 等 |
+| **BJ** | 北京证券交易所 | 北交所股票 |
+
+### 目前支持状态
+
+- **A 股（SH / SZ / BJ）**：已支持。可查实时行情、日 K、分钟 K、日内分时、财务数据等。
+
+按标的查询时传入上述格式的字符串或列表即可：
+
+```python
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+# 上交所整体实时数据
+df = client.quotes.get(exchange=["SSE"], as_df=True)
+
+print(df)
+```
+
+---
+
+## 基础用法
+
+### K 线获取
+
+**单个或者批量获取分钟k线**：
+
+```python
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+symbols = ["601717.SH", "601928.SH"]
+
+# 获取分钟 K 线，返回原始数据
+kline_data = client.klines.get_batch_real_time(symbols=symbols, period="1m", count=5, adjust="before", as_df=True)
+print(f"601717.SH最新的1min k线数据: {kline_data['601717.SH']}")
+
+```
+
+### 获取实时行情
+
+**按标的代码查询**
+
+```python
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+symbols = ["600000.SH", "002534.SZ", "688003.SH"]
+
+df = client.quotes.get(symbols=symbols, as_df=True)
+
+print(df)
+```
+
+**按标的池查询**
+
+```python
+# 获取全部 上交所 A 股行情
+quotes_a = client.quotes.get(exchange=["SSE"], as_df=True)
+
+print(quotes_a)
+
+
+# 获取全部 上交所 深交所 A 股行情
+quotes = client.quotes.get(exchange=["SSE", "SZSE"], as_df=True)
+
+print(quotes)
+
+```
+
+### 获取打板数据
+
+**炸板池查询**
+
+```python
+
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+# 获取实时炸板池数据
+df = client.limit_up.limit_up_down_pool.broken_limit(as_df=True)
+
+print(df)
+
+```
+
+**强势股池查询**
+
+```python
+
+from sharetop import ShareTop
+
+token = ""
+
+client = ShareTop(token=token)
+
+# 获取实时强势股池数据
+df = client.limit_up.limit_up_down_pool.strong(as_df=True)
+
+print(df)
+
+```
+
+---
+
+## 更多文档
+
+- [完整示例](https://docs.tickflow.org/zh-Hans/sdk/python-examples) — 查看更多使用场景和代码示例
+- [最佳实践](https://docs.tickflow.org/zh-Hans/sdk/python-best-practices) — 了解生产环境的最佳实践
+- [API 参考](https://docs.tickflow.org/zh-Hans/api-reference/introduction) — HTTP API 接口说明
+
+---
+
+## License
+
+MIT

sharetop-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "sharetop"
+version = "0.1.0"
+description = "ShareTop Python Client"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "ShareTop Team", email = "support@sharetop.top"}
+]
+keywords = ["finance", "stock", "market-data", "trading", "api-client"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: Chinese (Simplified)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.25.0",
+    "typing-extensions>=4.0.0",
+    "pandas>=1.5.0",
+    "aiohttp>=3.9.0",
+    "tqdm>=4.60.0",
+]
+
+[project.optional-dependencies]
+gevent = ["gevent>=23.0.0"]
+full = ["sharetop[gevent]"]
+
+[project.urls]
+Documentation = "https://docs.sharetop.top"
+Repository = "https://github.com/sharetop-org/sharetop"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["sharetop*"]
+
+[tool.setuptools.package-data]
+sharetop = ["py.typed"]
+
+[dependency-groups]
+dev = [
+    "datamodel-code-generator[http]>=0.45.0",
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+]

sharetop-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sharetop-0.1.0/sharetop/__init__.py

@@ -0,0 +1,38 @@
+"""ShareTop Python SDK - 高性能行情数据客户端。
+
+支持 A股的基础数据和行情数据查询，提供同步和异步两种接口。
+
+"""
+
+from .__version__ import __version__
+from ._exceptions import (
+    APIError,
+    AuthenticationError,
+    BadRequestError,
+    ConnectionError,
+    InternalServerError,
+    NotFoundError,
+    PermissionError,
+    RateLimitError,
+    ShareTopError,
+    TimeoutError,
+)
+from .client import ShareTop
+
+
+__all__ = [
+    "__version__",
+    # Main clients
+    "ShareTop",
+    # Exceptions
+    "ShareTopError",
+    "APIError",
+    "AuthenticationError",
+    "PermissionError",
+    "NotFoundError",
+    "BadRequestError",
+    "RateLimitError",
+    "InternalServerError",
+    "ConnectionError",
+    "TimeoutError",
+]

sharetop-0.1.0/sharetop/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"