tickflow 0.1.0.dev0__py3-none-any.whl → 0.1.0.dev1__py3-none-any.whl

tickflow-0.1.0.dev1.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,17 @@
+tickflow/__init__.py,sha256=DirYoqzbnLlaMuzUVyXTCH1glwLKETbItwpUIag6Kdc,1540
+tickflow/_base_client.py,sha256=wjOG2BYYYn_SN97zm9bIWXSYJjPxgHJYbLlDgW9hrFw,15494
+tickflow/_exceptions.py,sha256=ckzZdwZQHwZOQD-nstsh8vIneUun2J3KU6i49TZ6UrI,3024
+tickflow/_types.py,sha256=bewfzijcLJwjQNRs6WXv_i62wUu5Vtn4XFeRkc15ch0,1371
+tickflow/client.py,sha256=O5a-W1A6-U5Ftdwp41f7itU3-iwyjvLgWW3pydVj6ps,8109
+tickflow/generated_model.py,sha256=yRFZqmQMbhn3WwQ4U_cRTPYB1WDX3NSKwPEm2e3uUUg,5656
+tickflow/resources/__init__.py,sha256=JayIwwlrRnSAI83fy97LfFstiYGz3qzdmbxApiIJNtU,477
+tickflow/resources/_base.py,sha256=KcaNDouymvPp9FC4QJuYzBdioYB2wTIIdmLKoomtb58,667
+tickflow/resources/exchanges.py,sha256=EtWBcOA_3VG9OaCHwXJ0HMjZIxylFoJu6XS8nzvv7_w,4580
+tickflow/resources/instruments.py,sha256=xE0IK42MuyWQAhlObC_9Xecm-JnrDHu281t_NzqoPis,5863
+tickflow/resources/klines.py,sha256=h13Ptou-d074gl0BB9irUnJ_iwaTxK0B-l7LXrH3tsE,23674
+tickflow/resources/quotes.py,sha256=nC4xniwOtQbkgixCrl-wheJarGXxIG2hjwkLNBmwbxk,12161
+tickflow/resources/universes.py,sha256=Pk--9Zlt6vfq9SzzkuJENkDAUUGmqiq4kdeOjMKXWQU,4542
+tickflow-0.1.0.dev1.dist-info/METADATA,sha256=uc0c3JSIkInbvuc42bMFyKr-cNenJAJKkLT86A9srsU,2682
+tickflow-0.1.0.dev1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+tickflow-0.1.0.dev1.dist-info/top_level.txt,sha256=_0JOxGpAnD-wmnVj9CKo6Bwp2qNC0xWdbDXJX8B1jrs,9
+tickflow-0.1.0.dev1.dist-info/RECORD,,

tickflow/resources/symbols.py

@@ -1,176 +0,0 @@
-"""Symbol metadata resources for TickFlow API."""
-
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, List, Union, overload
-
-from ._base import AsyncResource, SyncResource
-
-if TYPE_CHECKING:
-    from ..generated_model import SymbolMeta
-
-
-class Symbols(SyncResource):
-    """Synchronous interface for symbol metadata endpoints.
-
-    Examples
-    --------
-    >>> client = TickFlow(api_key="your-key")
-    >>> meta = client.symbols.get("600000.SH")
-    >>> print(f"{meta['symbol']}: {meta['name']}")
-    """
-
-    @overload
-    def get(self, symbol: str) -> "SymbolMeta": ...
-
-    @overload
-    def get(self, symbol: List[str]) -> List["SymbolMeta"]: ...
-
-    def get(
-        self, symbol: Union[str, List[str]]
-    ) -> Union["SymbolMeta", List["SymbolMeta"]]:
-        """Get metadata for one or more symbols.
-
-        Parameters
-        ----------
-        symbol : str or list of str
-            Symbol code(s). Can be a single symbol string or a list of symbols.
-
-        Returns
-        -------
-        SymbolMeta or list of SymbolMeta
-            If a single symbol is provided, returns a single SymbolMeta dict.
-            If a list is provided, returns a list of SymbolMeta dicts.
-
-            Each SymbolMeta contains:
-            - symbol: Full symbol code (e.g., "600000.SH")
-            - code: Exchange-specific code (e.g., "600000")
-            - exchange: Exchange code (e.g., "SH")
-            - region: Region code (e.g., "CN")
-            - name: Symbol name
-            - symbol_type: Type (stock, etf, index, etc.)
-            - ext: Market-specific extension data
-
-        Examples
-        --------
-        >>> # Single symbol
-        >>> meta = client.symbols.get("600000.SH")
-        >>> print(meta['name'])
-
-        >>> # Multiple symbols
-        >>> metas = client.symbols.get(["600000.SH", "AAPL.US"])
-        >>> for m in metas:
-        ...     print(f"{m['symbol']}: {m['name']}")
-        """
-        if isinstance(symbol, str):
-            response = self._client.get("/v1/symbols", params={"symbols": symbol})
-            data = response["data"]
-            return data[0] if data else {}
-        else:
-            # Use POST for batch queries
-            response = self._client.post("/v1/symbols", json={"symbols": symbol})
-            return response["data"]
-
-    def batch(self, symbols: List[str]) -> List["SymbolMeta"]:
-        """Get metadata for multiple symbols.
-
-        This method uses POST to handle large batches without URL length limits.
-
-        Parameters
-        ----------
-        symbols : list of str
-            List of symbol codes (up to 1000).
-
-        Returns
-        -------
-        list of SymbolMeta
-            List of symbol metadata dicts.
-
-        Examples
-        --------
-        >>> metas = client.symbols.batch(["600000.SH", "000001.SZ", "AAPL.US"])
-        >>> for m in metas:
-        ...     print(f"{m['symbol']}: {m['name']}")
-        """
-        response = self._client.post("/v1/symbols", json={"symbols": symbols})
-        return response["data"]
-
-
-class AsyncSymbols(AsyncResource):
-    """Asynchronous interface for symbol metadata endpoints.
-
-    Examples
-    --------
-    >>> async with AsyncTickFlow(api_key="your-key") as client:
-    ...     meta = await client.symbols.get("600000.SH")
-    """
-
-    @overload
-    async def get(self, symbol: str) -> "SymbolMeta": ...
-
-    @overload
-    async def get(self, symbol: List[str]) -> List["SymbolMeta"]: ...
-
-    async def get(
-        self, symbol: Union[str, List[str]]
-    ) -> Union["SymbolMeta", List["SymbolMeta"]]:
-        """Get metadata for one or more symbols.
-
-        Parameters
-        ----------
-        symbol : str or list of str
-            Symbol code(s). Can be a single symbol string or a list of symbols.
-
-        Returns
-        -------
-        SymbolMeta or list of SymbolMeta
-            If a single symbol is provided, returns a single SymbolMeta dict.
-            If a list is provided, returns a list of SymbolMeta dicts.
-
-            Each SymbolMeta contains:
-            - symbol: Full symbol code (e.g., "600000.SH")
-            - code: Exchange-specific code (e.g., "600000")
-            - exchange: Exchange code (e.g., "SH")
-            - region: Region code (e.g., "CN")
-            - name: Symbol name
-            - symbol_type: Type (stock, etf, index, etc.)
-            - ext: Market-specific extension data
-
-        Examples
-        --------
-        >>> # Single symbol
-        >>> meta = await client.symbols.get("600000.SH")
-        >>> print(meta['name'])
-
-        >>> # Multiple symbols
-        >>> metas = await client.symbols.get(["600000.SH", "AAPL.US"])
-        """
-        if isinstance(symbol, str):
-            response = await self._client.get("/v1/symbols", params={"symbols": symbol})
-            data = response["data"]
-            return data[0] if data else {}
-        else:
-            response = await self._client.post("/v1/symbols", json={"symbols": symbol})
-            return response["data"]
-
-    async def batch(self, symbols: List[str]) -> List["SymbolMeta"]:
-        """Get metadata for multiple symbols.
-
-        This method uses POST to handle large batches without URL length limits.
-
-        Parameters
-        ----------
-        symbols : list of str
-            List of symbol codes (up to 1000).
-
-        Returns
-        -------
-        list of SymbolMeta
-            List of symbol metadata dicts.
-
-        Examples
-        --------
-        >>> metas = await client.symbols.batch(["600000.SH", "000001.SZ", "AAPL.US"])
-        """
-        response = await self._client.post("/v1/symbols", json={"symbols": symbols})
-        return response["data"]

tickflow-0.1.0.dev0.dist-info/METADATA

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: tickflow
-Version: 0.1.0.dev0
-Summary: TickFlow Python Client - High-performance market data API for A-shares, US stocks, and Hong Kong stocks
-Author: TickFlow Team
-License: MIT
-Project-URL: Homepage, https://tickflow.org
-Project-URL: Documentation, https://docs.tickflow.org
-Project-URL: Repository, https://github.com/tickflow/tickflow-python
-Keywords: finance,market-data,stocks,trading,api-client,async
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Financial and Insurance Industry
-Classifier: License :: OSI Approved :: MIT License
-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: Topic :: Office/Business :: Financial :: Investment
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Typing :: Typed
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: pandas>=1.3.0
-Requires-Dist: typing-extensions>=4.0.0
-Provides-Extra: pandas
-Requires-Dist: pandas>=1.3.0; extra == "pandas"
-Provides-Extra: all
-Requires-Dist: pandas>=1.3.0; extra == "all"
-Provides-Extra: dev
-Requires-Dist: datamodel-code-generator[http]>=0.45.0; extra == "dev"
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"

tickflow-0.1.0.dev0.dist-info/RECORD

@@ -1,17 +0,0 @@
-tickflow/__init__.py,sha256=ZP7_vxm2g-PEMDJAxRjUIDB0S5WQ7DRIKjBJVFvD3uc,3061
-tickflow/_base_client.py,sha256=akiDPhdQUjxJU_xaBvlUmo4LnGKLaq6_WIVlEX9DHzM,10622
-tickflow/_exceptions.py,sha256=ckzZdwZQHwZOQD-nstsh8vIneUun2J3KU6i49TZ6UrI,3024
-tickflow/_types.py,sha256=bewfzijcLJwjQNRs6WXv_i62wUu5Vtn4XFeRkc15ch0,1371
-tickflow/client.py,sha256=PZdWYGRYWF-xUkn1s2qHdrlmDBASludadcH1T9jy5B0,7674
-tickflow/generated_model.py,sha256=YNvz4TG9Fajh_s_Cfn40_pkAnndI81r6clB5OR9Fdkk,5410
-tickflow/resources/__init__.py,sha256=RLaTibvIPX4GSATttmzJfoiFg81p4S_b4pgfFx0pP8c,457
-tickflow/resources/_base.py,sha256=KcaNDouymvPp9FC4QJuYzBdioYB2wTIIdmLKoomtb58,667
-tickflow/resources/exchanges.py,sha256=qPVvjsZLuISuMfElD_BSYSNS2CIuLqm_dsfeI6OrXOs,3414
-tickflow/resources/klines.py,sha256=Wx11iX9AK1qOIAxxkcTqI36FpnK--BUzNLydks4342E,15632
-tickflow/resources/quotes.py,sha256=nC4xniwOtQbkgixCrl-wheJarGXxIG2hjwkLNBmwbxk,12161
-tickflow/resources/symbols.py,sha256=T33FX3FzM6h2JebXMJVNcjM5eSWiQ2vp63DJk4PmYcA,5664
-tickflow/resources/universes.py,sha256=Pk--9Zlt6vfq9SzzkuJENkDAUUGmqiq4kdeOjMKXWQU,4542
-tickflow-0.1.0.dev0.dist-info/METADATA,sha256=98ipSJKIB7cpOKy8tJVcNjYP1d7ntC-VEte74qot2nY,1587
-tickflow-0.1.0.dev0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-tickflow-0.1.0.dev0.dist-info/top_level.txt,sha256=_0JOxGpAnD-wmnVj9CKo6Bwp2qNC0xWdbDXJX8B1jrs,9
-tickflow-0.1.0.dev0.dist-info/RECORD,,