openbb-akshare 0.3.5__py3-none-any.whl

openbb_akshare/utils/tools.py

@@ -0,0 +1,142 @@
+# Add these imports at the top
+from datetime import datetime, timedelta
+import os
+
+# support logging
+import logging
+from logging.handlers import RotatingFileHandler
+
+# Configure logging
+def setup_logger():
+    # Create logs directory if it doesn't exist
+    log_dir = "logs"
+    log_file = os.path.join(log_dir, "openbb_akshare.log")
+    os.makedirs(log_dir, exist_ok=True)
+
+    # Log format
+    log_format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    formatter = logging.Formatter(log_format)
+
+    # Log to console
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(formatter)
+
+    # Log to file (with rotation)
+    file_handler = RotatingFileHandler(
+        log_file,
+        maxBytes=1024 * 1024,  # 1MB per file
+        backupCount=5,          # Keep 5 backups
+    )
+    file_handler.setFormatter(formatter)
+
+    # Root logger configuration
+    logging.basicConfig(
+        level=logging.INFO,     # Default level
+        handlers=[console_handler, file_handler]
+    )
+
+def get_working_days(start_date: str, end_date: str) -> int:
+    """Calculate number of working days between two dates"""
+    start = datetime.strptime(start_date, "%Y%m%d")
+    end = datetime.strptime(end_date, "%Y%m%d")
+    days = 0
+    current = start
+    
+    while current <= end:
+        # Skip weekends (5 = Saturday, 6 = Sunday)
+        if current.weekday() < 5:
+            days += 1
+        current += timedelta(days=1)
+    
+    return days
+
+def get_symbol_base(symbol: str) -> str:
+    """
+    Get the base symbol from a stock symbol with market suffix.
+    """
+    if "." in symbol:
+        base, market = symbol.split(".")
+        # Handle Hong Kong market special case (HKI -> HK)
+        if market == "HKI":
+            market = "HK"
+        return base
+    else:
+        # Raise exception if no market suffix is present
+        raise ValueError(f"Symbol '{symbol}' must include a market suffix (e.g., .SH, .SZ, .HK)")
+
+def normalize_symbol(symbol: str) -> tuple[str, str, str]:
+    """
+    Normalize a stock symbol by determining its market and returning the standardized format.
+    
+    Args:
+        symbol (str): Stock symbol with or without market suffix (e.g., "601006.SH" or "601006")
+    
+    Returns:
+        tuple[str, str]: A tuple containing (normalized_symbol, market_suffix)
+        
+    Examples:
+        >>> normalize_symbol("601006")
+        ("601006", "601006.SH", "SH")
+        >>> normalize_symbol("601006.SH")
+        ("601006", "601006.SH", "SH")
+        >>> normalize_symbol("0700.HK")
+        ("0700", "0700.HK", "HK")
+        >>> normalize_symbol("00700.HK")
+        ("00700", "00700.HK", "HK")
+        >>> normalize_symbol("00700")
+        ("00700", "00700.HK", "HK")
+    """
+    # If symbol already contains market suffix
+    if "." in symbol:
+        base, market = symbol.split(".")
+        # Handle Hong Kong market special case (HKI -> HK)
+        if market == "HKI":
+            market = "HK"
+        return base, f"{base}.{market}", market
+
+    # No market suffix, determine by pattern
+    # Shanghai market (starts with 6)
+    if symbol.startswith("6") and len(symbol) == 6:
+        return symbol, f"{symbol}.SH", "SH"
+    
+    # Beijing market (starts with 43, 83, 87, 88, 92 or 93)
+    if (symbol.startswith("4") or symbol.startswith("8") or symbol.startswith("9")) and len(symbol) == 6:
+        return symbol, f"{symbol}.BJ", "BJ"
+    
+    # Shenzhen market (starts with 000 or 300)
+    # TODO: check "00" at the moment, should be "000", "001", "002", "300"
+    if len(symbol) == 6 and (symbol.startswith("00") or symbol.startswith("300")):
+        return symbol, f"{symbol}.SZ", "SZ"
+    
+    # Hong Kong market - 4 digits or 5 digits starting with 0
+    if len(symbol) == 4 and symbol.isdigit():
+        return symbol, f"{symbol}.HK", "HK"
+    
+    # Check for 5-digit Hong Kong symbols that start with 0
+    if len(symbol) == 5 and symbol.isdigit() and symbol.startswith("0"):
+        return symbol, f"{symbol}.HK", "HK"
+    
+    # Singapore market (typically ends with SI)
+    if symbol.endswith("SI"):
+        return symbol, f"{symbol}.SI", "SI"
+    
+    # US market (default case - assume any remaining symbols are US stocks)
+    return symbol, f"{symbol}.US", "US"
+
+def normalize_date(date: str) -> str:
+    """Normalize date format from %Y-%m-%d to %Y%m%d if needed."""
+    try:
+        # Try to parse the date with the hyphen format
+        date_obj = datetime.strptime(date, "%Y-%m-%d")
+        # If successful, convert to the desired format
+        return date_obj.strftime("%Y%m%d")
+    except ValueError:
+        # If parsing fails, return the original string
+        return date
+
+# 示例调用
+if __name__ == "__main__":
+    start_date = "20230101"
+    end_date = "20230110"
+    working_days = get_working_days(start_date, end_date)
+    print(f"从 {start_date} 到 {end_date} 的工作日数量: {working_days}")

openbb_akshare-0.3.5.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.3
+Name: openbb-akshare
+Version: 0.3.5
+Summary: AKShare extension for OpenBB
+License: AGPL-3.0-only
+Author: Roger Ye
+Author-email: shugaoye@yahoo.com
+Requires-Python: >=3.9,<3.13
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+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
+Requires-Dist: akshare (==1.16.98)
+Requires-Dist: openbb-core (>=1.4.7,<2.0.0)
+Description-Content-Type: text/markdown
+
+# How to Use AKShare as a Data Source for OpenBB
+
+**OpenBB**, as an open-source financial data platform, is dedicated to providing free and transparent financial data interfaces for investors, analysts, and developers. For a detailed introduction to OpenBB and its usage, please refer to [Introduction to OpenBB and How to Use It to Aid Financial Data Analysis of China A-share and Hong Kong Stocks](https://medium.com/@shugaoye/introduction-to-openbb-and-how-to-use-it-to-aid-financial-data-analysis-of-china-a-share-and-hong-f4bbe480399a).
+
+Although OpenBB supports multi-source data interfaces, the acquisition of financial data in China (including Hong Kong) mainly relies on Yahoo Finance. As a free basic data source, it can meet basic needs, but its coverage depth for the Chinese and Hong Kong markets is still insufficient. More importantly, mainland Chinese users need to use a VPN to access this service, creating significant usage barriers.
+
+To enhance service capabilities in Greater China, OpenBB urgently needs to improve the implementation of localized financial data sources. The mainstream paid solutions include Wind, Eastmoney Choice, and 同花顺 iFind (mainly for institutional clients), while the free solutions focus on the open-source tool AKShare as the core solution. By integrating data interfaces from platforms such as Eastmoney, 同花顺, Tencent, Sina, and 雪球, AKShare has become one of the most comprehensive, up-to-date, and developer-friendly financial data aggregation libraries in the domestic Python ecosystem.
+
+The `openbb_akshare` project, as a data source extension for OpenBB, enables seamless integration of AKShare data into the OpenBB platform. Below is a detailed usage guide:
+
+## 💻 Environment Setup and Installation Process
+
+As developers, we primarily interact with the platform through the OpenBB Platform CLI. To integrate the AKShare data source, follow these steps to configure the development environment:
+
+1. **Create a Python Virtual Environment**
+
+   You can use `venv`, `uv`, or `poetry` to create a virtual environment. Here, we use venv (built into Python):
+
+   ```bash
+   # Create a virtual environment  
+   python3 -m venv .venv  
+   
+   # Activate the virtual environment (Linux/Mac)  
+   source .venv/bin/activate  
+   
+   # For Windows  
+   .venv\Scripts\activate  
+   ```
+
+2. **Install OpenBB Platform CLI**
+
+   Install the core OpenBB CLI via pip. Users in mainland China can configure a mirror for faster installation:
+
+   ```bash
+   # (Optional) Set a domestic mirror for pip  
+   # For Linux/Mac  
+   export PIP_INDEX_URL=https://mirrors.aliyun.com/pypi/simple 
+   
+   # Install OpenBB CLI
+   pip install openbb-cli
+   ```
+
+3. **Install openbb_akshare**
+
+   Next, install the `openbb_akshare` extenstion to use the AKShare data source:
+
+   ```bash
+   # Install the AKShare data source extension  
+   pip install openbb_akshare  
+   
+   # Rebuild OpenBB resources to activate the plugin  
+   python -c "import openbb; openbb.build()"  
+   ```
+
+## 🚀 Using the AKShare Data Source
+
+### Case 1: Query A-Share Company News (Vanke as an Example)
+
+**Jupyter Notebook**：
+
+```Python
+from openbb import obb
+messages = obb.news.company("000002", provider="akshare")
+for result in messages.results:
+    print(f"{result.title}")
+```
+
+Output：
+
+```plaintext
+开源证券发布万科A研报，公司信息更新报告：销售均价有所提升，股东持续借款提供支持
+万科A出售2086万股库存股，金额1.36亿元
+万科A：已完成所有A股库存股出售 所得资金4.79亿元
+...
+```
+
+**Using OpenBB CLI**：
+
+```bash
+openbb
+2025 Jun 26, 03:11 (🦋) /news/ $ company --symbol 000002 --provider akshare
+```
+
+After entering the command, the results will be displayed in a WebView, as shown below：
+
+![openbb04](docs/images/openbb04.png)
+
+### Case 2: Obtain Historical Stock Prices of Hong Kong Stocks (Hong Kong Telecom as an Example)
+
+**Using OpenBB CLI**:
+
+```
+2025 Jun 26, 03:28 (🦋) /equity/price/ $ historical --symbol 06823 --provider akshare
+```
+
+Results in WebView：![openbb05](docs/images/openbb05.png)
+
+**Jupyter Notebook**：
+
+```Python
+from openbb import obb
+prices = obb.equity.price.historical(symbol='06823', start_date="2025-06-01", end_date="2025-06-10", provider="akshare")
+prices.results[0].date, prices.results[0].open, prices.results[0].close, prices.results[0].high, prices.results[0].low, prices.results[0].volume
+```
+
+Output：
+
+```
+(datetime.date(2025, 6, 2), 11.28, 11.3, 11.3, 11.14, 10308375)
+```
+
+## 🌟 openbb_akshare Project Ecosystem
+
+The `openbb_akshare` project is currently in an active development phase, and contributions from the open-source community are welcome:
+
+### Code Repositories
+
+- **GitHub**: https://github.com/finanalyzer/openbb_akshare
+
+- **GitCode (Domestic Mirror)**: https://gitcode.com/finanalyzer/openbb_akshare
+
+### Ways to Contribute
+
+1. Submit Issues to report data needs or bugs.
+
+2. Contribute PRs to optimize data source interfaces.
+
+3. Improve documentation to help more users.
+
+Through the integration of AKShare and OpenBB, users in China can more conveniently access real-time and historical data for markets such as A-Shares and Hong Kong Stocks, providing strong data support for quantitative analysis and investment research.

openbb_akshare-0.3.5.dist-info/RECORD

@@ -0,0 +1,18 @@
+openbb_akshare/__init__.py,sha256=nnHZUe51A_IJM5rU52f98zRYGIy_4-Rpt_Kvc_xtXkI,1309
+openbb_akshare/models/__init__.py,sha256=m3gMD7E0l2sSs6hpLz247F7SmbdMTxNo8L91P2rq6vA,31
+openbb_akshare/models/available_indices.py,sha256=fMQU8OOLaVZ3FEb3_jnZTZRP46iopSL58XOw-RwEeIw,2209
+openbb_akshare/models/company_news.py,sha256=N37HR9pdI9ep9FM94xWmSxsqhNYHJz3eKKcR5t2T_EQ,3353
+openbb_akshare/models/equity_historical.py,sha256=FikSpUpKlj0ppwLxaIm9ENF0NlS2XqysagKou0N2gQ0,3763
+openbb_akshare/models/equity_quote.py,sha256=hiN2TD7Dys0yB62KsIuOWvrh1rdjjJovWY2P5ctR8Ig,4975
+openbb_akshare/models/historical_dividends.py,sha256=7fQXyi7QwOPoUPvAf9Kbl0Y6frrhTzXHpaVtu5Xv8xc,3621
+openbb_akshare/openbb.py,sha256=1brue1rid_-X-rBcDlEBu2IGrCuMYt_aJxEjXFxWgiY,1421
+openbb_akshare/router.py,sha256=XS2FnACxp0RcL72mBScgUn6i0VrOFkZ94dxMgGkyheU,1512
+openbb_akshare/utils/__init__.py,sha256=QbmiTSfL3BhE5-6KzGdMRWP2-G_laMNNZJWTkDMcoUU,30
+openbb_akshare/utils/futures.csv,sha256=xSZ2tybp__tNIRH__7O27SYepPC3hfGUTYPtVoIxQts,8563
+openbb_akshare/utils/helpers.py,sha256=er5RHe9nMgZIApb4RPtooW_IRuSQ80NE9gdIsoYaz10,8263
+openbb_akshare/utils/references.py,sha256=okVRuo5B4xMrI4Xh0jrX_ljHzxiUQgXlVWkUrLk4b_A,49061
+openbb_akshare/utils/tools.py,sha256=6RLoC5QQpBPBgZQpE7uqs7PYoT_mb1yrY6xP56xug3s,5041
+openbb_akshare-0.3.5.dist-info/entry_points.txt,sha256=rFeXrX0kT9a8JxVyOUEXBAqhe8IyTXa4QB-YHlLkrYk,137
+openbb_akshare-0.3.5.dist-info/METADATA,sha256=8jAd1AK9HkAq8KYFIofS6fkS0_XlyoL_SfqxAJ_JS7g,5940
+openbb_akshare-0.3.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openbb_akshare-0.3.5.dist-info/RECORD,,

openbb_akshare-0.3.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.3
+Root-Is-Purelib: true
+Tag: py3-none-any

openbb_akshare-0.3.5.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[openbb_core_extension]
+openbb_akshare=openbb_akshare.router:router
+
+[openbb_provider_extension]
+openbb_akshare=openbb_akshare:provider
+