tickflow 0.1.0.dev0__tar.gz → 0.1.0.dev1__tar.gz

tickflow-0.1.0.dev1/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: tickflow
+Version: 0.1.0.dev1
+Summary: TickFlow Python Client
+Author: TickFlow Team
+License: MIT
+Project-URL: Documentation, https://docs.tickflow.org
+Project-URL: Repository, https://github.com/tickflow/tickflow-python
+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: 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: Topic :: Office/Business :: Financial :: Investment
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.5.0; extra == "pandas"
+Provides-Extra: progress
+Requires-Dist: tqdm>=4.60.0; extra == "progress"
+Provides-Extra: all
+Requires-Dist: pandas>=1.5.0; extra == "all"
+Requires-Dist: tqdm>=4.60.0; extra == "all"
+
+# TickFlow Python SDK
+
+高性能行情数据 Python 客户端，支持 A股、美股、港股。
+
+## 安装
+
+```bash
+pip install tickflow
+```
+
+如需 DataFrame 支持和进度条功能：
+
+```bash
+pip install tickflow[all]
+```
+
+## 快速开始
+
+```python
+from tickflow import TickFlow
+
+# 初始化客户端
+client = TickFlow(api_key="your-api-key")
+
+# 获取 K 线数据
+df = client.klines.get("600000.SH", period="1d", count=100, as_dataframe=True)
+print(df.tail())
+
+# 获取实时行情
+quotes = client.quotes.get(symbols=["600000.SH", "AAPL.US"])
+for q in quotes:
+    print(f"{q['symbol']}: {q['last_price']}")
+```
+
+## 异步使用
+
+```python
+import asyncio
+from tickflow import AsyncTickFlow
+
+async def main():
+    async with AsyncTickFlow(api_key="your-api-key") as client:
+        df = await client.klines.get("600000.SH", as_dataframe=True)
+        print(df.tail())
+
+asyncio.run(main())
+```
+
+## 批量获取
+
+```python
+# 批量获取大量股票数据，自动分批并发请求
+symbols = client.exchanges.get_symbols("SH")[:500]
+df = client.klines.batch(
+    symbols,
+    period="1d",
+    as_dataframe=True,
+    show_progress=True  # 显示进度条
+)
+```
+
+## 特性
+
+- ✅ 同步/异步双接口
+- ✅ DataFrame 原生支持
+- ✅ 自动重试（网络错误、服务器错误）
+- ✅ 批量请求自动分片
+- ✅ 进度条支持
+- ✅ 完整类型注解
+
+## 文档
+
+完整文档请访问：https://docs.tickflow.org
+
+## License
+
+MIT

tickflow-0.1.0.dev1/README.md

@@ -0,0 +1,77 @@
+# TickFlow Python SDK
+
+高性能行情数据 Python 客户端，支持 A股、美股、港股。
+
+## 安装
+
+```bash
+pip install tickflow
+```
+
+如需 DataFrame 支持和进度条功能：
+
+```bash
+pip install tickflow[all]
+```
+
+## 快速开始
+
+```python
+from tickflow import TickFlow
+
+# 初始化客户端
+client = TickFlow(api_key="your-api-key")
+
+# 获取 K 线数据
+df = client.klines.get("600000.SH", period="1d", count=100, as_dataframe=True)
+print(df.tail())
+
+# 获取实时行情
+quotes = client.quotes.get(symbols=["600000.SH", "AAPL.US"])
+for q in quotes:
+    print(f"{q['symbol']}: {q['last_price']}")
+```
+
+## 异步使用
+
+```python
+import asyncio
+from tickflow import AsyncTickFlow
+
+async def main():
+    async with AsyncTickFlow(api_key="your-api-key") as client:
+        df = await client.klines.get("600000.SH", as_dataframe=True)
+        print(df.tail())
+
+asyncio.run(main())
+```
+
+## 批量获取
+
+```python
+# 批量获取大量股票数据，自动分批并发请求
+symbols = client.exchanges.get_symbols("SH")[:500]
+df = client.klines.batch(
+    symbols,
+    period="1d",
+    as_dataframe=True,
+    show_progress=True  # 显示进度条
+)
+```
+
+## 特性
+
+- ✅ 同步/异步双接口
+- ✅ DataFrame 原生支持
+- ✅ 自动重试（网络错误、服务器错误）
+- ✅ 批量请求自动分片
+- ✅ 进度条支持
+- ✅ 完整类型注解
+
+## 文档
+
+完整文档请访问：https://docs.tickflow.org
+
+## License
+
+MIT

{tickflow-0.1.0.dev0 → tickflow-0.1.0.dev1}/pyproject.toml

@@ -1,47 +1,44 @@
 [project]
 name = "tickflow"
-version = "0.1.0-dev"
-description = "TickFlow Python Client - High-performance market data API for A-shares, US stocks, and Hong Kong stocks"
+version = "0.1.0-dev1"
+description = "TickFlow Python Client"
 readme = "README.md"
 requires-python = ">=3.9"
-license = { text = "MIT" }
+license = {text = "MIT"}
 authors = [
-    { name = "TickFlow Team" }
+    {name = "TickFlow Team"}
 ]
-keywords = ["finance", "market-data", "stocks", "trading", "api-client", "async"]
+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",
-    "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",
     "Topic :: Office/Business :: Financial :: Investment",
-    "Topic :: Software Development :: Libraries :: Python Modules",
     "Typing :: Typed",
 ]
-
 dependencies = [
-    "httpx>=0.28.1",
-    "pandas>=1.3.0",
+    "httpx>=0.25.0",
     "typing-extensions>=4.0.0",
 ]
 
 [project.optional-dependencies]
-pandas = ["pandas>=1.3.0"]
-all = ["pandas>=1.3.0"]
-dev = [
-    "datamodel-code-generator[http]>=0.45.0",
-    "pytest>=7.0.0",
-    "pytest-asyncio>=0.21.0",
+# DataFrame support
+pandas = ["pandas>=1.5.0"]
+# Progress bar for batch operations
+progress = ["tqdm>=4.60.0"]
+# All optional features
+all = [
+    "pandas>=1.5.0",
+    "tqdm>=4.60.0",
 ]
 
 [project.urls]
-Homepage = "https://tickflow.org"
 Documentation = "https://docs.tickflow.org"
 Repository = "https://github.com/tickflow/tickflow-python"
 
@@ -50,13 +47,13 @@ requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
-where = ["."]
 include = ["tickflow*"]
 
-[tool.setuptools.package-data]
-tickflow = ["py.typed"]
-
-
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-testpaths = ["tests"]
+[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",
+]

tickflow-0.1.0.dev1/tickflow/__init__.py

@@ -0,0 +1,75 @@
+"""TickFlow Python SDK - 高性能行情数据客户端。
+
+支持 A股、美股、港股的行情数据查询，提供同步和异步两种接口。
+
+Examples
+--------
+同步使用:
+
+>>> from tickflow import TickFlow
+>>> client = TickFlow(api_key="your-api-key")
+>>> df = client.klines.get("600000.SH", as_dataframe=True)
+>>> print(df.tail())
+
+异步使用:
+
+>>> import asyncio
+>>> from tickflow import AsyncTickFlow
+>>>
+>>> async def main():
+...     async with AsyncTickFlow(api_key="your-api-key") as client:
+...         df = await client.klines.get("600000.SH", as_dataframe=True)
+...         print(df.tail())
+>>>
+>>> asyncio.run(main())
+"""
+
+from ._exceptions import (
+    APIError,
+    AuthenticationError,
+    BadRequestError,
+    ConnectionError,
+    InternalServerError,
+    NotFoundError,
+    PermissionError,
+    RateLimitError,
+    TickFlowError,
+    TimeoutError,
+)
+from .client import AsyncTickFlow, TickFlow
+from .generated_model import (
+    CompactKlineData,
+    Instrument,
+    InstrumentType,
+    Period,
+    Quote,
+    Region,
+    SessionStatus,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    # Main clients
+    "TickFlow",
+    "AsyncTickFlow",
+    # Exceptions
+    "TickFlowError",
+    "APIError",
+    "AuthenticationError",
+    "PermissionError",
+    "NotFoundError",
+    "BadRequestError",
+    "RateLimitError",
+    "InternalServerError",
+    "ConnectionError",
+    "TimeoutError",
+    # Types
+    "CompactKlineData",
+    "Instrument",
+    "InstrumentType",
+    "Period",
+    "Quote",
+    "Region",
+    "SessionStatus",
+]