akshare-one 0.3.1__tar.gz → 0.3.3__tar.gz

{akshare_one-0.3.1 → akshare_one-0.3.3}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 zwldarren
-
-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.
+MIT License
+
+Copyright (c) 2025 zwldarren
+
+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.

{akshare_one-0.3.1 → akshare_one-0.3.3}/PKG-INFO

@@ -1,70 +1,70 @@
-Metadata-Version: 2.4
-Name: akshare-one
-Version: 0.3.1
-Summary: Standardized interface for Chinese financial market data, built on AKShare with unified data formats and simplified APIs
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/zwldarren/akshare-one
-Project-URL: Repository, https://github.com/zwldarren/akshare-one.git
-Keywords: akshare,financial-data,stock-data,quant
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: akshare>=1.17.15
-Requires-Dist: cachetools>=6.1.0
-Provides-Extra: talib
-Requires-Dist: ta-lib>=0.6.4; extra == "talib"
-Dynamic: license-file
-
-<div align="center">
-  <h1>AKShare One</h1>
-  <div>
-    <a href="README_zh.md">中文</a> | <strong>English</strong>
-  </div>
-</div>
-
-**AKShare One** is a data interface for obtaining Chinese A-shares, based on [AKShare](https://github.com/akfamily/akshare). It aims to simplify AKShare's usage and unify input/output formats from different data sources, making it easier to pass data to LLM.
-
-## ✨ Features
-
-- 📊 Unified stock code formats across data sources
-- 🏗️ Standardized return data structures
-- 🛠️ Simplified API parameter design
-- ⏱️ Automatic timestamp and adjustment handling
-
-## 🚀 Core Features
-
-| Function | Interface |
-|------|------|
-| Historical data | `get_hist_data` |
-| Real-time quotes | `get_realtime_data` |
-| Stock news | `get_news_data` |
-| Financial data | `get_balance_sheet`/`get_income_statement`/`get_cash_flow` |
-| Internal transactions | `get_inner_trade_data` |
-| Technical indicators | See [indicators.py](akshare_one/indicators.py) |
-
-## 📦 Quick Installation
-
-```bash
-pip install akshare-one
-```
-
-## 💻 Usage Example
-
-```python
-from akshare_one import get_hist_data
-from akshare_one.indicators import get_sma
-
-# Get historical data
-df = get_hist_data(
-    symbol="600000",
-    interval="day",
-    adjust="hfq"
-)
-
-# Calculate 20-day Simple Moving Average
-df_sma = get_sma(df, window=20)
-```
-
-## 📚 Documentation
-
-Detailed API reference: [docs/api.md](docs/api.md)
+Metadata-Version: 2.4
+Name: akshare-one
+Version: 0.3.3
+Summary: Standardized interface for Chinese financial market data, built on AKShare with unified data formats and simplified APIs
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/zwldarren/akshare-one
+Project-URL: Repository, https://github.com/zwldarren/akshare-one.git
+Keywords: akshare,financial-data,stock-data,quant
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: akshare>=1.17.20
+Requires-Dist: cachetools>=5.5.2
+Provides-Extra: talib
+Requires-Dist: ta-lib>=0.6.4; extra == "talib"
+Dynamic: license-file
+
+<div align="center">
+  <h1>AKShare One</h1>
+  <div>
+    <a href="README_zh.md">中文</a> | <strong>English</strong>
+  </div>
+</div>
+
+**AKShare One** is a data interface for obtaining Chinese A-shares, based on [AKShare](https://github.com/akfamily/akshare). It aims to simplify AKShare's usage and unify input/output formats from different data sources, making it easier to pass data to LLM.
+
+## ✨ Features
+
+- 📊 Unified stock code formats across data sources
+- 🏗️ Standardized return data structures
+- 🛠️ Simplified API parameter design
+- ⏱️ Automatic timestamp and adjustment handling
+
+## 🚀 Core Features
+
+| Function | Interface |
+|------|------|
+| Historical data | `get_hist_data` |
+| Real-time quotes | `get_realtime_data` |
+| Stock news | `get_news_data` |
+| Financial data | `get_balance_sheet`/`get_income_statement`/`get_cash_flow` |
+| Internal transactions | `get_inner_trade_data` |
+| Technical indicators | See [indicators.py](akshare_one/indicators.py) |
+
+## 📦 Quick Installation
+
+```bash
+pip install akshare-one
+```
+
+## 💻 Usage Example
+
+```python
+from akshare_one import get_hist_data
+from akshare_one.indicators import get_sma
+
+# Get historical data
+df = get_hist_data(
+    symbol="600000",
+    interval="day",
+    adjust="hfq"
+)
+
+# Calculate 20-day Simple Moving Average
+df_sma = get_sma(df, window=20)
+```
+
+## 📚 Documentation
+
+Detailed API reference: [docs/api.md](docs/api.md)

{akshare_one-0.3.1 → akshare_one-0.3.3}/README.md

@@ -1,53 +1,53 @@
-<div align="center">
-  <h1>AKShare One</h1>
-  <div>
-    <a href="README_zh.md">中文</a> | <strong>English</strong>
-  </div>
-</div>
-
-**AKShare One** is a data interface for obtaining Chinese A-shares, based on [AKShare](https://github.com/akfamily/akshare). It aims to simplify AKShare's usage and unify input/output formats from different data sources, making it easier to pass data to LLM.
-
-## ✨ Features
-
-- 📊 Unified stock code formats across data sources
-- 🏗️ Standardized return data structures
-- 🛠️ Simplified API parameter design
-- ⏱️ Automatic timestamp and adjustment handling
-
-## 🚀 Core Features
-
-| Function | Interface |
-|------|------|
-| Historical data | `get_hist_data` |
-| Real-time quotes | `get_realtime_data` |
-| Stock news | `get_news_data` |
-| Financial data | `get_balance_sheet`/`get_income_statement`/`get_cash_flow` |
-| Internal transactions | `get_inner_trade_data` |
-| Technical indicators | See [indicators.py](akshare_one/indicators.py) |
-
-## 📦 Quick Installation
-
-```bash
-pip install akshare-one
-```
-
-## 💻 Usage Example
-
-```python
-from akshare_one import get_hist_data
-from akshare_one.indicators import get_sma
-
-# Get historical data
-df = get_hist_data(
-    symbol="600000",
-    interval="day",
-    adjust="hfq"
-)
-
-# Calculate 20-day Simple Moving Average
-df_sma = get_sma(df, window=20)
-```
-
-## 📚 Documentation
-
-Detailed API reference: [docs/api.md](docs/api.md)
+<div align="center">
+  <h1>AKShare One</h1>
+  <div>
+    <a href="README_zh.md">中文</a> | <strong>English</strong>
+  </div>
+</div>
+
+**AKShare One** is a data interface for obtaining Chinese A-shares, based on [AKShare](https://github.com/akfamily/akshare). It aims to simplify AKShare's usage and unify input/output formats from different data sources, making it easier to pass data to LLM.
+
+## ✨ Features
+
+- 📊 Unified stock code formats across data sources
+- 🏗️ Standardized return data structures
+- 🛠️ Simplified API parameter design
+- ⏱️ Automatic timestamp and adjustment handling
+
+## 🚀 Core Features
+
+| Function | Interface |
+|------|------|
+| Historical data | `get_hist_data` |
+| Real-time quotes | `get_realtime_data` |
+| Stock news | `get_news_data` |
+| Financial data | `get_balance_sheet`/`get_income_statement`/`get_cash_flow` |
+| Internal transactions | `get_inner_trade_data` |
+| Technical indicators | See [indicators.py](akshare_one/indicators.py) |
+
+## 📦 Quick Installation
+
+```bash
+pip install akshare-one
+```
+
+## 💻 Usage Example
+
+```python
+from akshare_one import get_hist_data
+from akshare_one.indicators import get_sma
+
+# Get historical data
+df = get_hist_data(
+    symbol="600000",
+    interval="day",
+    adjust="hfq"
+)
+
+# Calculate 20-day Simple Moving Average
+df_sma = get_sma(df, window=20)
+```
+
+## 📚 Documentation
+
+Detailed API reference: [docs/api.md](docs/api.md)

akshare_one-0.3.3/akshare_one/__init__.py

@@ -0,0 +1,214 @@
+"""Akshare One - Unified interface for Chinese market data
+
+Provides standardized access to various financial data sources with:
+- Consistent symbol formats
+- Unified data schemas
+- Cleaned and normalized outputs
+
+Example:
+    >>> from akshare_one import get_hist_data, get_realtime_data
+    >>> # 获取股票历史数据
+    >>> df = get_hist_data("600000", interval="day")
+    >>> print(df.head())
+    >>> # 获取股票实时数据
+    >>> df = get_realtime_data(symbol="600000")
+"""
+
+from typing import Optional, Literal
+import pandas as pd
+from .modules.financial.factory import FinancialDataFactory
+from .modules.historical.factory import HistoricalDataFactory
+from .modules.realtime.factory import RealtimeDataFactory
+from .modules.info.factory import InfoDataFactory
+from .modules.news.factory import NewsDataFactory
+from .modules.insider.factory import InsiderDataFactory
+
+
+def get_basic_info(
+    symbol: str, source: Literal["eastmoney"] = "eastmoney"
+) -> pd.DataFrame:
+    """获取股票基础信息
+
+    Args:
+        symbol: 股票代码 (e.g. '600000')
+        source: 数据源 ('eastmoney')
+
+    Returns:
+        pd.DataFrame:
+        - price: 最新价
+        - symbol: 股票代码
+        - name: 股票简称
+        - total_shares: 总股本
+        - float_shares: 流通股
+        - total_market_cap: 总市值
+        - float_market_cap: 流通市值
+        - industry: 行业
+        - listing_date: 上市时间
+    """
+    provider = InfoDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_basic_info()
+
+
+def get_hist_data(
+    symbol: str,
+    interval: Literal["minute", "hour", "day", "week", "month", "year"] = "day",
+    interval_multiplier: int = 1,
+    start_date: str = "1970-01-01",
+    end_date: str = "2030-12-31",
+    adjust: Literal["none", "qfq", "hfq"] = "none",
+    source: Literal["eastmoney", "eastmoney_direct", "sina"] = "eastmoney",
+) -> pd.DataFrame:
+    """Get historical market data
+
+    Args:
+        symbol: 股票代码 (e.g. '600000')
+        interval: 时间间隔 ('minute','hour','day','week','month','year')
+        interval_multiplier: 时间间隔倍数 (e.g. 5 for 5 minutes)
+        start_date: 开始日期 (YYYY-MM-DD)
+        end_date: 结束日期 (YYYY-MM-DD)
+        adjust: 复权类型 ('none','qfq','hfq')
+        source: 数据源 ('eastmoney', 'eastmoney_direct', 'sina') (default: 'eastmoney')
+
+    Returns:
+        pd.DataFrame:
+        - timestamp: 时间戳(UTC时区)
+        - open: 开盘价
+        - high: 最高价
+        - low: 最低价
+        - close: 收盘价
+        - volume: 成交量
+    """
+    kwargs = {
+        "symbol": symbol,
+        "interval": interval,
+        "interval_multiplier": interval_multiplier,
+        "start_date": start_date,
+        "end_date": end_date,
+        "adjust": adjust,
+    }
+    provider = HistoricalDataFactory.get_provider(source, **kwargs)
+    return provider.get_hist_data()
+
+
+def get_realtime_data(
+    symbol: Optional[str] = None,
+    source: Literal["eastmoney", "eastmoney_direct", "xueqiu"] = "xueqiu",
+) -> pd.DataFrame:
+    """Get real-time market quotes
+
+    Args:
+        symbol: 股票代码 (如 "600000")
+        source: 数据源 ('eastmoney', 'eastmoney_direct', 'xueqiu')
+
+    Returns:
+        pd.DataFrame:
+        - symbol: 股票代码
+        - price: 最新价
+        - change: 涨跌额
+        - pct_change: 涨跌幅(%)
+        - timestamp: 时间戳
+        - volume: 成交量(手)
+        - amount: 成交额(元)
+        - open: 今开
+        - high: 最高
+        - low: 最低
+        - prev_close: 昨收
+    """
+    provider = RealtimeDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_current_data()
+
+
+def get_news_data(
+    symbol: str, source: Literal["eastmoney"] = "eastmoney"
+) -> pd.DataFrame:
+    """获取个股新闻数据
+
+    Args:
+        symbol: 股票代码 (如 "300059")
+        source: 数据源 ('eastmoney')
+
+    Returns:
+        pd.DataFrame:
+        - keyword: 关键词
+        - title: 新闻标题
+        - content: 新闻内容
+        - publish_time: 发布时间
+        - source: 文章来源
+        - url: 新闻链接
+    """
+    provider = NewsDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_news_data()
+
+
+def get_balance_sheet(symbol: str, source: Literal["sina"] = "sina") -> pd.DataFrame:
+    """获取资产负债表数据
+
+    Args:
+        symbol: 股票代码 (如 "600600")
+        source: 数据源 ("sina")
+
+    Returns:
+        pd.DataFrame: 资产负债表数据
+    """
+    provider = FinancialDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_balance_sheet()
+
+
+def get_income_statement(symbol: str, source: Literal["sina"] = "sina") -> pd.DataFrame:
+    """获取利润表数据
+
+    Args:
+        symbol: 股票代码 (如 "600600")
+        source: 数据源 ("sina")
+
+    Returns:
+        pd.DataFrame: 利润表数据
+    """
+    provider = FinancialDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_income_statement()
+
+
+def get_cash_flow(symbol: str, source: Literal["sina"] = "sina") -> pd.DataFrame:
+    """获取现金流量表数据
+
+    Args:
+        symbol: 股票代码 (如 "600600")
+        source: 数据源 ("sina")
+
+    Returns:
+        pd.DataFrame: 现金流量表数据
+    """
+    provider = FinancialDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_cash_flow()
+
+
+def get_financial_metrics(
+    symbol: str, source: Literal["eastmoney"] = "eastmoney"
+) -> pd.DataFrame:
+    """获取三大财务报表关键指标
+
+    Args:
+        symbol: 股票代码 (如 "600600")
+        source: 数据源 ('eastmoney')
+
+    Returns:
+        pd.DataFrame: 财务关键指标数据
+    """
+    provider = FinancialDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_financial_metrics()
+
+
+def get_inner_trade_data(
+    symbol: str, source: Literal["xueqiu"] = "xueqiu"
+) -> pd.DataFrame:
+    """获取雪球内部交易数据
+
+    Args:
+        symbol: 股票代码，如"600000"
+        source: 数据源 (目前支持 "xueqiu")
+
+    Returns:
+        pd.DataFrame: 内部交易数据
+    """
+    provider = InsiderDataFactory.get_provider(source, symbol=symbol)
+    return provider.get_inner_trade_data()