neurostats-API 0.0.15__tar.gz → 0.0.16__tar.gz

{neurostats_API-0.0.15/neurostats_API.egg-info → neurostats_api-0.0.16}/PKG-INFO

@@ -1,12 +1,18 @@
 Metadata-Version: 2.1
-Name: neurostats-API
-Version: 0.0.15
+Name: neurostats_API
+Version: 0.0.16
 Summary: The service of NeuroStats website
 Home-page: https://github.com/NeurowattStats/NeuroStats_API.git
 Author: JasonWang@Neurowatt
 Author-email: jason@neurowatt.ai
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
+Requires-Dist: numpy>=2.1.0
+Requires-Dist: pandas>=2.2.0
+Requires-Dist: pymongo
+Requires-Dist: pytz
+Requires-Dist: python-dotenv
+Requires-Dist: yfinance
 
 # neurostats_API
 
@@ -83,7 +89,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.15
+0.0.16
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -685,21 +691,25 @@ fetcher = FinanceReportFetcher(
 
 data = fetcher.get(
     ticker = "2330" # 任意的股票代碼
-    fetch_mode = fetcher.YOY_NOCAL # 取得模式
+    fetch_mode = fetcher.FetchMode.QOQ_NOCAL # 取得模式
     start_date = "2005-01-01",
     end_date = "2024-12-31",
     report_type = "Q",
     indexes = []
-)
+) # -> pd.DataFrame or Dict[pd.DataFrame] 
 ```
 - `ticker`: 股票代碼
 
 - `fetch_mode` : 取得模式，為`fetcher.YOY_NOCAL` 或 `fetcher.QOQ_NOCAL`
-    - `YOY_NOCAL`: 以end_date為準，取得與end_date為準同季的歷年資料，時間範圍以start_date為準
+    - `YOY_NOCAL`: 以end_date為準，取得與end_date同季的歷年資料，時間範圍以start_date為起始
         > 例如`start_date = "2020-07-01"`, `end_date = "2024-01-01"`，會回傳2020~2024的第一季資料
 
     - `QOQ_NOCAL`: 時間範圍內的每季資料
 
+    - `QOQ`: 時間範圍內每季的每個index的數值以及QoQ
+
+    - `YoY`: 以end_date為準，取得與end_date同季的歷年資料以及成長率，時間範圍以start_date為起始
+
 - `start_date`: 開始日期，不設定時預設為`2005-01-01`
 
 - `end_date`: 結束日期，不設定時預設為資料庫最新資料的日期
@@ -716,10 +726,61 @@ data = fetcher.get(
 請看 `會計師簽證財務資料`
 
 #### 回傳資料
-fetch_mode設定為`YOY_NOCAL`與`QOQ_NOCAL`下
-為回傳pd.DataFrame，column名稱為<年份>Q<季>， row名稱為指定財報項目
+##### `YOY_NOCAL` 與 `QOQ_NOCAL` 
+為回傳`pd.DataFrame`，column名稱為<年份>Q<季>， row名稱為指定財報項目
+```Python
+# fetch_mode = fetcher.FetchMode.QOQ_NOCAL
+        2024Q3        2024Q2        2024Q1
+bp41  7.082005e+07  6.394707e+07  5.761001e+07
+bp51  3.111298e+09  3.145373e+09  3.091985e+09
+
+# fetch_mode = fetcher.FetchMode.YOY_NOCAL
+        2024Q3        2023Q3        2022Q3
+bp41  7.082005e+07  5.377231e+07  6.201822e+07
+bp51  3.111298e+09  3.173919e+09  2.453840e+09
+```
+
+##### `YOY` 與 `QOQ`
+回傳為`Dict[pd.DataFrame]`, key 為指定的index, DataFrame中則是該index歷年的數值與成長率
+```Python
+# fetch_mode = fetcher.FetchMode.QOQ
+{
+        'bp41':               
+        2024Q3        2024Q2        2024Q1
+value   7.082005e+07  6.394707e+07  5.761001e+07
+growth  1.074791e-01  1.099994e-01  5.532101e-03, 
+        'bp51':               
+        2024Q3        2024Q2        2024Q1
+value   3.111298e+09  3.145373e+09  3.091985e+09
+growth -1.083335e-02  1.726663e-02 -4.159542e-03
+}
+
+# fetch_mode = fetcher.FetchMode.YOY
+{
+'bp41':               
+        2024Q3        2023Q3        2022Q3
+value   7.082005e+07  5.377231e+07  6.201822e+07
+YoY_1            NaN           NaN  4.130744e-01
+YoY_3   1.729171e-01  9.556684e-02  1.883274e-01
+YoY_5   1.389090e-01  1.215242e-01  1.642914e-01
+YoY_10  1.255138e-01  1.356297e-01  1.559702e-01, 
+'bp51':               
+        2024Q3        2023Q3        2022Q3
+value   3.111298e+09  3.173919e+09  2.453840e+09
+YoY_1            NaN           NaN  3.179539e-01
+YoY_3   1.866752e-01  2.766851e-01  2.638677e-01
+YoY_5   2.068132e-01  2.479698e-01  1.815106e-01
+YoY_10  1.420500e-01  1.586797e-01  1.551364e-01
+}
+```
+
 
 ## 版本紀錄
+## 0.0.16
+- 處理ValueFetcher的error #issue76
+
+- tej_fetcher新增 QOQ, YOY功能
+
 ## 0.0.15
 - TechFetcher中新增指數條件
 

neurostats_API-0.0.15/PKG-INFO → neurostats_api-0.0.16/README.md

@@ -1,13 +1,3 @@
-Metadata-Version: 2.1
-Name: neurostats_API
-Version: 0.0.15
-Summary: The service of NeuroStats website
-Home-page: https://github.com/NeurowattStats/NeuroStats_API.git
-Author: JasonWang@Neurowatt
-Author-email: jason@neurowatt.ai
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-
 # neurostats_API
 
 - [檔案架構](#檔案架構)
@@ -83,7 +73,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.15
+0.0.16
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -685,21 +675,25 @@ fetcher = FinanceReportFetcher(
 
 data = fetcher.get(
     ticker = "2330" # 任意的股票代碼
-    fetch_mode = fetcher.YOY_NOCAL # 取得模式
+    fetch_mode = fetcher.FetchMode.QOQ_NOCAL # 取得模式
     start_date = "2005-01-01",
     end_date = "2024-12-31",
     report_type = "Q",
     indexes = []
-)
+) # -> pd.DataFrame or Dict[pd.DataFrame] 
 ```
 - `ticker`: 股票代碼
 
 - `fetch_mode` : 取得模式，為`fetcher.YOY_NOCAL` 或 `fetcher.QOQ_NOCAL`
-    - `YOY_NOCAL`: 以end_date為準，取得與end_date為準同季的歷年資料，時間範圍以start_date為準
+    - `YOY_NOCAL`: 以end_date為準，取得與end_date同季的歷年資料，時間範圍以start_date為起始
         > 例如`start_date = "2020-07-01"`, `end_date = "2024-01-01"`，會回傳2020~2024的第一季資料
 
     - `QOQ_NOCAL`: 時間範圍內的每季資料
 
+    - `QOQ`: 時間範圍內每季的每個index的數值以及QoQ
+
+    - `YoY`: 以end_date為準，取得與end_date同季的歷年資料以及成長率，時間範圍以start_date為起始
+
 - `start_date`: 開始日期，不設定時預設為`2005-01-01`
 
 - `end_date`: 結束日期，不設定時預設為資料庫最新資料的日期
@@ -716,10 +710,61 @@ data = fetcher.get(
 請看 `會計師簽證財務資料`
 
 #### 回傳資料
-fetch_mode設定為`YOY_NOCAL`與`QOQ_NOCAL`下
-為回傳pd.DataFrame，column名稱為<年份>Q<季>， row名稱為指定財報項目
+##### `YOY_NOCAL` 與 `QOQ_NOCAL` 
+為回傳`pd.DataFrame`，column名稱為<年份>Q<季>， row名稱為指定財報項目
+```Python
+# fetch_mode = fetcher.FetchMode.QOQ_NOCAL
+        2024Q3        2024Q2        2024Q1
+bp41  7.082005e+07  6.394707e+07  5.761001e+07
+bp51  3.111298e+09  3.145373e+09  3.091985e+09
+
+# fetch_mode = fetcher.FetchMode.YOY_NOCAL
+        2024Q3        2023Q3        2022Q3
+bp41  7.082005e+07  5.377231e+07  6.201822e+07
+bp51  3.111298e+09  3.173919e+09  2.453840e+09
+```
+
+##### `YOY` 與 `QOQ`
+回傳為`Dict[pd.DataFrame]`, key 為指定的index, DataFrame中則是該index歷年的數值與成長率
+```Python
+# fetch_mode = fetcher.FetchMode.QOQ
+{
+        'bp41':               
+        2024Q3        2024Q2        2024Q1
+value   7.082005e+07  6.394707e+07  5.761001e+07
+growth  1.074791e-01  1.099994e-01  5.532101e-03, 
+        'bp51':               
+        2024Q3        2024Q2        2024Q1
+value   3.111298e+09  3.145373e+09  3.091985e+09
+growth -1.083335e-02  1.726663e-02 -4.159542e-03
+}
+
+# fetch_mode = fetcher.FetchMode.YOY
+{
+'bp41':               
+        2024Q3        2023Q3        2022Q3
+value   7.082005e+07  5.377231e+07  6.201822e+07
+YoY_1            NaN           NaN  4.130744e-01
+YoY_3   1.729171e-01  9.556684e-02  1.883274e-01
+YoY_5   1.389090e-01  1.215242e-01  1.642914e-01
+YoY_10  1.255138e-01  1.356297e-01  1.559702e-01, 
+'bp51':               
+        2024Q3        2023Q3        2022Q3
+value   3.111298e+09  3.173919e+09  2.453840e+09
+YoY_1            NaN           NaN  3.179539e-01
+YoY_3   1.866752e-01  2.766851e-01  2.638677e-01
+YoY_5   2.068132e-01  2.479698e-01  1.815106e-01
+YoY_10  1.420500e-01  1.586797e-01  1.551364e-01
+}
+```
+
 
 ## 版本紀錄
+## 0.0.16
+- 處理ValueFetcher的error #issue76
+
+- tej_fetcher新增 QOQ, YOY功能
+
 ## 0.0.15
 - TechFetcher中新增指數條件
 
@@ -752,4 +797,4 @@ fetch_mode設定為`YOY_NOCAL`與`QOQ_NOCAL`下
 - 處理銀行公司在finanace_overview會報錯誤的問題(未完全解決，因銀行公司財報有許多名稱不同，目前都會顯示為None)
 
 ### 0.0.9
-- 更新指標的資料型態: 單位為日, %, 倍轉為字串
+- 更新指標的資料型態: 單位為日, %, 倍轉為字串

{neurostats_API-0.0.15 → neurostats_api-0.0.16}/neurostats_API/__init__.py

@@ -1,4 +1,4 @@
-__version__='0.0.15'
+__version__='0.0.16'
 
 from .fetchers import (
     BalanceSheetFetcher,

{neurostats_API-0.0.15 → neurostats_api-0.0.16}/neurostats_API/fetchers/base.py

@@ -7,10 +7,12 @@ from datetime import datetime, timedelta, date
 from ..utils import StatsDateTime, StatsProcessor, YoY_Calculator
 import yaml
 
+
 class StatsFetcher:
+
     def __init__(self, ticker, db_client):
         self.ticker = ticker
-        self.db = db_client["company"]  # Replace with your database name
+        self.db = db_client["company"]    # Replace with your database name
         self.collection = self.db["twse_stats"]
 
         self.timezone = pytz.timezone("Asia/Taipei")
@@ -26,7 +28,6 @@ class StatsFetcher:
             'grand_total_growth': [f"YoY_{i}" for i in [1, 3, 5, 10]]
         }
 
-
     def prepare_query(self):
         return [
             {
@@ -53,7 +54,9 @@ class StatsFetcher:
 
         return StatsDateTime(date, year, month, day, season)
 
+
 class BaseTEJFetcher(abc.ABC):
+
     def __init__(self):
         self.client = None
         self.db = None
@@ -62,25 +65,22 @@ class BaseTEJFetcher(abc.ABC):
     @abc.abstractmethod
     def get(self):
         pass
-    
+
     def get_latest_data_time(self, ticker):
-        latest_data = self.collection.find_one(
-            {"ticker": ticker},
-            {"last_update": 1, "_id" : 0}
-        )
+        latest_data = self.collection.find_one({"ticker": ticker}, {"last_update": 1, "_id": 0})
 
         try:
             latest_date = latest_data['last_update']["latest_data_date"]
         except Exception as e:
             latest_date = None
-        
+
         return latest_date
 
-    def cal_YoY(self, data_dict: dict, start_year: int, end_year: int):
-        year_shifts = [1,3,5,10]
+    def cal_YoY(self, data_dict: dict, start_year: int, end_year: int, season: int):
+        year_shifts = [1, 3, 5, 10]
         return_dict = {}
-        for year in range(start_year, end_year+1):
-            year_data = data_dict[str(year)]
+        for year in range(start_year, end_year + 1):
+            year_data = data_dict[f"{year}Q{season}"]
             year_keys = list(year_data.keys())
             for key in year_keys:
                 if (key in 'season'):
@@ -93,23 +93,20 @@ class BaseTEJFetcher(abc.ABC):
                         this_value = year_data[key]
                         try:
                             past_year = str(year - shift)
-                            last_value = data_dict[past_year][key]['value']
-                            temp_dict[f"YoY_{shift}"] = YoY_Calculator.cal_growth(
-                                this_value, last_value, delta = shift
-                            )
+                            last_value = data_dict[f"{past_year}Q{season}"][key]
+                            temp_dict[f"YoY_{shift}"] = YoY_Calculator.cal_growth(this_value, last_value, delta=shift)
                         except Exception as e:
                             temp_dict[f"YoY_{shift}"] = None
-                        
+
                     year_data[key] = temp_dict
 
                 else:
                     year_data.pop(key)
-            
-            return_dict[year] = year_data
-        
-        
+
+            return_dict[f"{year}Q{season}"] = year_data
+
         return return_dict
-    
+
     def cal_QoQ(self, data_dict):
         return_dict = {}
         for i, time_index in enumerate(data_dict.keys()):
@@ -122,7 +119,7 @@ class BaseTEJFetcher(abc.ABC):
             else:
                 last_year = year
                 last_season = season - 1
-            
+
             this_data = data_dict[time_index]
             this_keys = list(this_data.keys())
             for key in this_keys:
@@ -137,16 +134,21 @@ class BaseTEJFetcher(abc.ABC):
                     try:
                         last_value = data_dict[f"{last_year}Q{last_season}"][key]['value']
 
-                        temp_dict['growth'] = YoY_Calculator.cal_growth(
-                            this_value, last_value, delta=1
-                        )
+                        temp_dict['growth'] = YoY_Calculator.cal_growth(this_value, last_value, delta=1)
                     except Exception as e:
                         temp_dict['growth'] = None
-                        
+
                     this_data[key] = temp_dict
 
                 else:
                     this_data.pop(key)
             return_dict[time_index] = this_data
         return return_dict
-            
+
+    def get_dict_of_df(self, data_dict):
+        """
+        dict[dict] -> dict[df]
+        """
+        for key in data_dict.keys():
+            data_dict[key] = pd.DataFrame.from_dict(data_dict[key])
+        return data_dict