Merge pull request #16 from shugaoye/master

chore: update dependencies and version for openbb-akshare

Author: finanalyzer

openbb_akshare/__init__.py

@@ -13,6 +13,7 @@
 from openbb_akshare.models.equity_historical import AKShareEquityHistoricalFetcher
 from openbb_akshare.models.equity_profile import AKShareEquityProfileFetcher
 from openbb_akshare.models.equity_screener import AKShareEquityScreenerFetcher
+from openbb_akshare.models.equity_search import AKShareEquitySearchFetcher
 from openbb_akshare.models.historical_dividends import AKShareHistoricalDividendsFetcher
 from openbb_akshare.models.income_statement import AKShareIncomeStatementFetcher
 from openbb_akshare.models.key_metrics import AKShareKeyMetricsFetcher
@@ -38,6 +39,7 @@
         "EquityHistorical": AKShareEquityHistoricalFetcher,
         "EquityInfo": AKShareEquityProfileFetcher,
         "EquityScreener": AKShareEquityScreenerFetcher,
+        "EquitySearch": AKShareEquitySearchFetcher,
         "HistoricalDividends": AKShareHistoricalDividendsFetcher,
         "IncomeStatement": AKShareIncomeStatementFetcher,
         "KeyMetrics": AKShareKeyMetricsFetcher,

openbb_akshare/models/balance_sheet.py

@@ -13,6 +13,13 @@
 from openbb_core.provider.utils.descriptions import QUERY_DESCRIPTIONS
 from pydantic import Field, field_validator
 
+import logging
+from openbb_akshare import project_name
+from mysharelib.tools import setup_logger
+
+setup_logger(project_name)
+logger = logging.getLogger(__name__)
+
 
 class AKShareBalanceSheetQueryParams(BalanceSheetQueryParams):
     """AKShare Balance Sheet Query.
@@ -93,13 +100,10 @@ def extract_data(
         **kwargs: Any,
     ) -> list[dict]:
         """Extract the data from the AKShare endpoints."""
+        api_key = credentials.get("akshare_api_key") if credentials else ""
         # pylint: disable=import-outside-toplevel
-        em_df = get_data(query.symbol, query.period, query.use_cache)
-
-        if query.limit is None:
-            return em_df.to_dict(orient="records")
-        else:
-            return em_df.head(query.limit).to_dict(orient="records")
+        em_df = get_data(query.symbol, query.period, query.use_cache, api_key=api_key, limit=query.limit)
+        return em_df.head(query.limit).to_dict(orient="records")
 
     @staticmethod
     def transform_data(
@@ -110,21 +114,15 @@ def transform_data(
         """Transform the data."""
         return [AKShareBalanceSheetData.model_validate(d) for d in data]
 
-def get_data(symbol: str, period: str = "annual", use_cache: bool = True) -> pd.DataFrame:
+def get_data(symbol: str, period: Literal["annual", "quarter"] = "annual", use_cache: bool = True, api_key:str="", limit:int = 5) -> pd.DataFrame:
     from openbb_akshare import project_name
     from mysharelib.blob_cache import BlobCache
     cache = BlobCache(table_name="balance_sheet", project=project_name)
-    return cache.load_cached_data(symbol, period, use_cache, get_ak_data)
-
-def get_ak_data(symbol: str, period: str = "annual", api_key : Optional[str] = "") -> pd.DataFrame:
-    import akshare as ak
-    from openbb_akshare.utils.helpers import normalize_symbol
-    symbol_b, symbol_f, market = normalize_symbol(symbol)
-    symbol_em = f"{market}{symbol_b}"
-
-    if period == "annual":
-        return ak.stock_balance_sheet_by_yearly_em(symbol=symbol_em)
-    elif period == "quarter":
-        return ak.stock_balance_sheet_by_report_em(symbol=symbol_em)
-    else:
-        raise ValueError("Invalid period. Please use 'annual' or 'quarter'.")
+    logger.info(f"Fetching balance sheet data for {symbol} with limit {limit} and use_cache={use_cache}")
+    return cache.load_cached_data(symbol, period, use_cache, get_ak_data, api_key, limit)
+
+def get_ak_data(symbol: str, period: Literal["annual", "quarter"] = "annual", api_key : Optional[str] = "", limit:int = 5) -> pd.DataFrame:
+    from openbb_akshare.utils.ak_balance_sheet import ak_stock_balance_sheet
+
+    logger.info(f"Getting balance sheet data for {symbol} with limit {limit}")
+    return ak_stock_balance_sheet(symbol, limit, period)

openbb_akshare/models/cash_flow.py

@@ -6,6 +6,12 @@
 from typing import Any, Literal, Optional
 
 from openbb_core.provider.abstract.fetcher import Fetcher
+import logging
+from openbb_akshare import project_name
+from mysharelib.tools import setup_logger
+
+setup_logger(project_name)
+logger = logging.getLogger(__name__)
 from openbb_core.provider.standard_models.cash_flow import (
     CashFlowStatementData,
     CashFlowStatementQueryParams,
@@ -94,7 +100,8 @@ def extract_data(
     ) -> list[dict]:
         """Extract the data from the AKShare endpoints."""
         # pylint: disable=import-outside-toplevel
-        em_df = get_data(query.symbol, query.period, query.use_cache)
+        api_key = credentials.get("akshare_api_key") if credentials else ""
+        em_df = get_data(query.symbol, query.period, query.use_cache, api_key=api_key, limit=query.limit)
 
         if query.limit is None:
             return em_df.to_dict(orient="records")
@@ -110,22 +117,15 @@ def transform_data(
         """Transform the data."""
         return [AKShareCashFlowStatementData.model_validate(d) for d in data]
 
-def get_data(symbol: str, period: str = "annual", use_cache: bool = True) -> pd.DataFrame:
+def get_data(symbol: str, period: Literal["annual", "quarter"] = "annual", use_cache: bool = True, api_key:str="", limit:int = 5) -> pd.DataFrame:
     from openbb_akshare import project_name
     from mysharelib.blob_cache import BlobCache
-
     cache = BlobCache(table_name="cash_flow", project=project_name)
-    return cache.load_cached_data(symbol, period, use_cache, get_ak_data)
-
-def get_ak_data(symbol: str, period: str = "annual", api_key : Optional[str] = "") -> pd.DataFrame:
-    import akshare as ak
-    from openbb_akshare.utils.helpers import normalize_symbol
-    symbol_b, symbol_f, market = normalize_symbol(symbol)
-    symbol_em = f"{market}{symbol_b}"
-
-    if period == "annual":
-        return ak.stock_cash_flow_sheet_by_yearly_em(symbol=symbol_em)
-    elif period == "quarter":
-        return ak.stock_cash_flow_sheet_by_report_em(symbol=symbol_em)
-    else:
-        raise ValueError("Invalid period. Please use 'annual' or 'quarter'.")
+    logger.info(f"Fetching cash flow data for {symbol} with limit {limit} and use_cache={use_cache}")
+    return cache.load_cached_data(symbol, period, use_cache, get_ak_data, api_key, limit)
+
+def get_ak_data(symbol: str, period: Literal["annual", "quarter"] = "annual", api_key : Optional[str] = "", limit:int = 5) -> pd.DataFrame:
+    from openbb_akshare.utils.ak_cash_flow import ak_stock_cash_flow
+
+    logger.info(f"Getting cash flow data for {symbol} with limit {limit}")
+    return ak_stock_cash_flow(symbol, limit, period)

openbb_akshare/models/company_news.py

@@ -62,22 +62,34 @@ async def aextract_data(
         # pylint: disable=import-outside-toplevel
         import asyncio  # noqa
         from openbb_core.provider.utils.errors import EmptyDataError
-        from openbb_core.provider.utils.helpers import get_requests_session
         import akshare as ak
+        from mysharelib.tools import normalize_symbol
 
         results: list = []
         symbols = query.symbol.split(",")  # type: ignore
         async def get_one(symbol):
-            data = ak.stock_news_em(symbol)
-            for idx, d in data.iterrows():
-                new_content: dict = {}
-                new_content["text"] = d["新闻内容"]
-                new_content["url"] = d["新闻链接"]
-                new_content["source"] = d["文章来源"]
-                new_content["title"] = d["新闻标题"]
-                new_content["date"] = d["发布时间"]
-
-                results.append(new_content)
+            from mysharelib.sina.scrape_hk_stock_news import scrape_hk_stock_news
+            from mysharelib.em.stock_info_em import stock_info_em
+
+            symbol_b, _, market = normalize_symbol(symbol)
+            if market == "HK":
+                data = scrape_hk_stock_news(symbol_b)
+                if data is not None:
+                    for d in data.to_dict(orient='records'):
+                        new_content: dict = {}
+                        new_content["date"] = d["date"]
+                        new_content["title"] = d["title"]
+                        new_content["url"] = d["url"]
+                        results.append(new_content)
+            else:
+                data = stock_info_em(symbol)
+                for idx, d in data.iterrows():
+                    new_content: dict = {}
+                    new_content["url"] = d["新闻链接"]
+                    new_content["title"] = d["新闻标题"]
+                    new_content["date"] = d["发布时间"]
+
+                    results.append(new_content)
 
         tasks = [get_one(symbol) for symbol in symbols]
 

openbb_akshare/models/equity_search.py

@@ -0,0 +1,84 @@
+"""AKShare Equity Search Model."""
+
+from typing import Any, Dict, List, Optional
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_search import (
+    EquitySearchData,
+    EquitySearchQueryParams,
+)
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+from pydantic import Field
+
+import logging
+from openbb_akshare import project_name
+from mysharelib.tools import setup_logger
+
+setup_logger(project_name)
+logger = logging.getLogger(__name__)
+
+
+class AKShareEquitySearchQueryParams(EquitySearchQueryParams):
+    """AKShare Equity Search Query.
+    """
+
+    use_cache: bool = Field(
+        default=True,
+        description="Whether to use a cached request. The quote is cached for one hour.",
+    )
+    limit: Optional[int] = Field(
+        default=10000,
+        description=QUERY_DESCRIPTIONS.get("limit", ""),
+    )
+
+
+class AKShareEquitySearchData(EquitySearchData):
+    """AKShare Equity Search Data."""
+
+
+class AKShareEquitySearchFetcher(
+    Fetcher[
+        AKShareEquitySearchQueryParams,
+        List[AKShareEquitySearchData],
+    ]
+):
+    """Transform the query, extract and transform the data from the AKShare endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> AKShareEquitySearchQueryParams:
+        """Transform the query."""
+        return AKShareEquitySearchQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: AKShareEquitySearchQueryParams,  # pylint: disable=unused-argument
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the AKShare endpoint."""
+
+        from openbb_akshare.utils.ak_equity_search import get_symbols
+        api_key = credentials.get("akshare_api_key") if credentials else ""
+        data = get_symbols(query.use_cache, api_key=api_key)
+        if query.limit: data = data.head(query.limit)
+
+        return data.to_dict(orient="records")
+
+    @staticmethod
+    def transform_data(
+        query: AKShareEquitySearchQueryParams, data: Dict, **kwargs: Any
+    ) -> List[AKShareEquitySearchData]:
+        """Transform the data to the standard format."""
+
+        if query.query:
+            filtered = [
+                d for d in data
+                if query.query in d.get('name', '') or query.query in d.get('symbol', '')
+            ]
+            logger.info(f"Searching for {query.query} and found {len(filtered)} results.")
+            return [AKShareEquitySearchData.model_validate(d) for d in filtered]
+
+        return [AKShareEquitySearchData.model_validate(d) for d in data]

openbb_akshare/models/income_statement.py

@@ -9,6 +9,12 @@
 from typing import Any, Dict, List, Literal, Optional
 
 from openbb_core.provider.abstract.fetcher import Fetcher
+import logging
+from openbb_akshare import project_name
+from mysharelib.tools import setup_logger
+
+setup_logger(project_name)
+logger = logging.getLogger(__name__)
 from openbb_core.provider.standard_models.income_statement import (
     IncomeStatementData,
     IncomeStatementQueryParams,
@@ -98,8 +104,9 @@ async def extract_data(
         **kwargs: Any,
     ) -> List[Dict]:
         """Return the raw data from the AKShare endpoint."""
+        api_key = credentials.get("akshare_api_key") if credentials else ""
 
-        em_df = get_data(query.symbol, query.period, query.use_cache)
+        em_df = get_data(query.symbol, query.period, query.use_cache, api_key=api_key, limit=query.limit)
 
         if query.limit is None:
             return em_df.to_dict(orient="records")
@@ -116,21 +123,15 @@ def transform_data(
             result.pop("cik", None)
         return [AKShareIncomeStatementData.model_validate(d) for d in data]
 
-def get_data(symbol: str, period: str = "annual", use_cache: bool = True) -> pd.DataFrame:
+def get_data(symbol: str, period: Literal["annual", "quarter"] = "annual", use_cache: bool = True, api_key:str="", limit:int = 5) -> pd.DataFrame:
     from openbb_akshare import project_name
     from mysharelib.blob_cache import BlobCache
     cache = BlobCache(table_name="income_statement", project=project_name)
-    return cache.load_cached_data(symbol, period, use_cache, get_income_statement)
-
-def get_income_statement(symbol: str, period: str = "annual", api_key : Optional[str] = "") -> pd.DataFrame:
-    import akshare as ak
-    from openbb_akshare.utils.helpers import normalize_symbol
-    symbol_b, symbol_f, market = normalize_symbol(symbol)
-    symbol_em = f"{market}{symbol_b}"
-
-    if period == "annual":
-        return ak.stock_profit_sheet_by_yearly_em(symbol=symbol_em)
-    elif period == "quarter":
-        return ak.stock_profit_sheet_by_report_em(symbol=symbol_em)
-    else:
-        raise ValueError("Invalid period. Please use 'annual' or 'quarter'.")
+    logger.info(f"Fetching income statement data for {symbol} with limit {limit} and use_cache={use_cache}")
+    return cache.load_cached_data(symbol, period, use_cache, get_income_statement, api_key, limit)
+
+def get_income_statement(symbol: str, period: Literal["annual", "quarter"] = "annual", api_key : Optional[str] = "", limit:int = 5) -> pd.DataFrame:
+    from openbb_akshare.utils.ak_income_statement import ak_stock_income_statement
+
+    logger.info(f"Getting income statement data for {symbol} with limit {limit}")
+    return ak_stock_income_statement(symbol, limit, period)

openbb_akshare/router.py

@@ -13,48 +13,13 @@
 
 router = Router(prefix="")
 
-@register_widget({
-    "name": "Company Facts",
-    "description": "Get key company information including name, CIK, market cap, total employees, website URL, and more.",
-    "category": "Equity",
-    "subcategory": "Company Info",
-    "type": "table",
-    "widgetId": "company_facts",
-    "endpoint": "company_facts",
-    "gridData": {
-        "w": 10,
-        "h": 12
-    },
-    "params": [
-        {
-            "type": "endpoint",
-            "paramName": "ticker",
-            "label": "Symbol",
-            "value": "600325",
-            "description": "Ticker to get company facts for (Free tier: AAPL, MSFT, TSLA)",
-            "optionsEndpoint": "/stock_tickers"
-        }
-    ]
-})
 @router.command(methods=["GET"])
-async def company_facts(symbol: str = "600325") -> OBBject[dict]:
+async def get_example(symbol: str = "AAPL") -> OBBject[dict]:
     """Get options data."""
-    import numpy as np
-    import pandas as pd
+    base_url = "https://www.cboe.com/education/tools/trade-optimizer/symbol-info"
 
-    from openbb_akshare.utils.fetch_equity_info import fetch_equity_info
-    from mysharelib.tools import normalize_symbol
-
-    user_setting = UserService.read_from_file()
-    credentials = user_setting.credentials
-    api_key = credentials.akshare_api_key.get_secret_value()
-    df = fetch_equity_info(symbol, api_key=api_key, use_cache=True)
-    df.set_index('symbol', inplace=True)
-    
-    _, symbol_f, _ = normalize_symbol(symbol)
-    data = df.T.to_dict(orient="dict")[symbol_f]
-    
-    return OBBject(results=data)
+    response = requests.get(base_url + f"?symbol={symbol}", timeout=5).json()
+    return OBBject(results=response["details"])
 
 
 @router.command(methods=["POST"])