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

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neurostats_API
-Version: 0.0.14
+Version: 0.0.15
 Summary: The service of NeuroStats website
 Home-page: https://github.com/NeurowattStats/NeuroStats_API.git
 Author: JasonWang@Neurowatt
@@ -83,7 +83,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.14
+0.0.15
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -667,7 +667,66 @@ fetcher.query()
 
 請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
 
+
+## TEJ 相關
+### 會計師簽證財務資料
+```Python
+from neurostats_API import FinanceReportFetcher
+
+mongo_uri = <MongoDB 的 URI>
+db_name = 'company' # 連接的DB名稱
+collection_name = "TWN/AINVFQ1" # 連接的collection對象
+
+fetcher = FinanceReportFetcher(
+    mongo_uri = mongo_uri,
+    db_name = db_name,
+    collection_name = collection_name
+)
+
+data = fetcher.get(
+    ticker = "2330" # 任意的股票代碼
+    fetch_mode = fetcher.YOY_NOCAL # 取得模式
+    start_date = "2005-01-01",
+    end_date = "2024-12-31",
+    report_type = "Q",
+    indexes = []
+)
+```
+- `ticker`: 股票代碼
+
+- `fetch_mode` : 取得模式，為`fetcher.YOY_NOCAL` 或 `fetcher.QOQ_NOCAL`
+    - `YOY_NOCAL`: 以end_date為準，取得與end_date為準同季的歷年資料，時間範圍以start_date為準
+        > 例如`start_date = "2020-07-01"`, `end_date = "2024-01-01"`，會回傳2020~2024的第一季資料
+
+    - `QOQ_NOCAL`: 時間範圍內的每季資料
+
+- `start_date`: 開始日期，不設定時預設為`2005-01-01`
+
+- `end_date`: 結束日期，不設定時預設為資料庫最新資料的日期
+
+- `report_type`: 選擇哪種報告，預設為`Q`
+    - `A`: 當年累計
+    - `Q`: 當季數值
+    - `TTM`: 移動四季 (包括當季在內，往前累計四個季度)
+
+- `indexes`: 選擇的column，需要以TEJ提供的欄位名稱為準，不提供時或提供`[]`會回傳全部column
+   - 範例輸入: `['bp41', 'bp51']`
+
+[TEJ資料集連結](https://tquant.tejwin.com/%E8%B3%87%E6%96%99%E9%9B%86/)
+請看 `會計師簽證財務資料`
+
+#### 回傳資料
+fetch_mode設定為`YOY_NOCAL`與`QOQ_NOCAL`下
+為回傳pd.DataFrame，column名稱為<年份>Q<季>， row名稱為指定財報項目
+
 ## 版本紀錄
+## 0.0.15
+- TechFetcher中新增指數條件
+
+- 新增tej_fetcher索取TEJ相關的資料
+
+- package新增depensnecy，可以安裝需要的相關package
+
 ## 0.0.14
 - 修改部分財報資料錯誤的乘以1000的問題
 

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/README.md

@@ -73,7 +73,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.14
+0.0.15
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -657,7 +657,66 @@ fetcher.query()
 
 請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
 
+
+## TEJ 相關
+### 會計師簽證財務資料
+```Python
+from neurostats_API import FinanceReportFetcher
+
+mongo_uri = <MongoDB 的 URI>
+db_name = 'company' # 連接的DB名稱
+collection_name = "TWN/AINVFQ1" # 連接的collection對象
+
+fetcher = FinanceReportFetcher(
+    mongo_uri = mongo_uri,
+    db_name = db_name,
+    collection_name = collection_name
+)
+
+data = fetcher.get(
+    ticker = "2330" # 任意的股票代碼
+    fetch_mode = fetcher.YOY_NOCAL # 取得模式
+    start_date = "2005-01-01",
+    end_date = "2024-12-31",
+    report_type = "Q",
+    indexes = []
+)
+```
+- `ticker`: 股票代碼
+
+- `fetch_mode` : 取得模式，為`fetcher.YOY_NOCAL` 或 `fetcher.QOQ_NOCAL`
+    - `YOY_NOCAL`: 以end_date為準，取得與end_date為準同季的歷年資料，時間範圍以start_date為準
+        > 例如`start_date = "2020-07-01"`, `end_date = "2024-01-01"`，會回傳2020~2024的第一季資料
+
+    - `QOQ_NOCAL`: 時間範圍內的每季資料
+
+- `start_date`: 開始日期，不設定時預設為`2005-01-01`
+
+- `end_date`: 結束日期，不設定時預設為資料庫最新資料的日期
+
+- `report_type`: 選擇哪種報告，預設為`Q`
+    - `A`: 當年累計
+    - `Q`: 當季數值
+    - `TTM`: 移動四季 (包括當季在內，往前累計四個季度)
+
+- `indexes`: 選擇的column，需要以TEJ提供的欄位名稱為準，不提供時或提供`[]`會回傳全部column
+   - 範例輸入: `['bp41', 'bp51']`
+
+[TEJ資料集連結](https://tquant.tejwin.com/%E8%B3%87%E6%96%99%E9%9B%86/)
+請看 `會計師簽證財務資料`
+
+#### 回傳資料
+fetch_mode設定為`YOY_NOCAL`與`QOQ_NOCAL`下
+為回傳pd.DataFrame，column名稱為<年份>Q<季>， row名稱為指定財報項目
+
 ## 版本紀錄
+## 0.0.15
+- TechFetcher中新增指數條件
+
+- 新增tej_fetcher索取TEJ相關的資料
+
+- package新增depensnecy，可以安裝需要的相關package
+
 ## 0.0.14
 - 修改部分財報資料錯誤的乘以1000的問題
 

neurostats_API-0.0.15/neurostats_API/__init__.py

@@ -0,0 +1,13 @@
+__version__='0.0.15'
+
+from .fetchers import (
+    BalanceSheetFetcher,
+    CashFlowFetcher,
+    FinanceOverviewFetcher,
+    FinanceReportFetcher,
+    InstitutionFetcher,
+    MarginTradingFetcher,
+    MonthRevenueFetcher,
+    TechFetcher,
+    ProfitLoseFetcher
+)

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/neurostats_API/fetchers/__init__.py

@@ -2,6 +2,8 @@ from .base import StatsDateTime, StatsFetcher
 from .balance_sheet import BalanceSheetFetcher
 from .cash_flow import CashFlowFetcher
 from .finance_overview import FinanceOverviewFetcher
+from .tej_finance_report import FinanceReportFetcher
+from .tech import TechFetcher
 from .institution import InstitutionFetcher
 from .margin_trading import MarginTradingFetcher
 from .month_revenue import MonthRevenueFetcher

neurostats_API-0.0.15/neurostats_API/fetchers/base.py

@@ -0,0 +1,152 @@
+import abc
+from pymongo import MongoClient
+import pandas as pd
+import json
+import pytz
+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.collection = self.db["twse_stats"]
+
+        self.timezone = pytz.timezone("Asia/Taipei")
+
+        self.target_metric_dict = {
+            'value': ['value'],
+            'value_and_percentage': ['value', 'percentage'],
+            'percentage': ['percentage'],
+            'grand_total': ['grand_total'],
+            'grand_total_values': ['grand_total', 'grand_total_percentage'],
+            'grand_total_percentage': ['grand_total_percentage'],
+            'growth': [f'YoY_{i}' for i in [1, 3, 5, 10]],
+            'grand_total_growth': [f"YoY_{i}" for i in [1, 3, 5, 10]]
+        }
+
+
+    def prepare_query(self):
+        return [
+            {
+                "$match": {
+                    "ticker": self.ticker,
+                }
+            },
+        ]
+
+    def collect_data(self, start_date, end_date):
+        pipeline = self.prepare_query()
+
+        fetched_data = list(self.collection.aggregate(pipeline))
+
+        return fetched_data[0]
+
+    def str_to_datetime(self, date_str):
+        year, month, day = [int(num) for num in date_str.split("-")]
+
+        date = datetime.strptime(date_str, "%Y-%m-%d")
+        date = self.timezone.localize(date)
+
+        season = (month - 1) // 3 + 1
+
+        return StatsDateTime(date, year, month, day, season)
+
+class BaseTEJFetcher(abc.ABC):
+    def __init__(self):
+        self.client = None
+        self.db = None
+        self.collection = None
+
+    @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}
+        )
+
+        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]
+        return_dict = {}
+        for year in range(start_year, end_year+1):
+            year_data = data_dict[str(year)]
+            year_keys = list(year_data.keys())
+            for key in year_keys:
+                if (key in 'season'):
+                    continue
+
+                if (isinstance(year_data[key], (int, float))):
+                    temp_dict = {"value": year_data[key]}
+
+                    for shift in year_shifts:
+                        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
+                            )
+                        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 return_dict
+    
+    def cal_QoQ(self, data_dict):
+        return_dict = {}
+        for i, time_index in enumerate(data_dict.keys()):
+            year, season = time_index.split("Q")
+            year = int(year)
+            season = int(season)
+            if (season == 1):
+                last_year = year - 1
+                last_season = 4
+            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:
+                if (key in 'season'):
+                    continue
+
+                this_value = this_data[key]
+
+                if (isinstance(this_value, (int, float))):
+                    temp_dict = {"value": this_value}
+
+                    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
+                        )
+                    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
+            

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/neurostats_API/fetchers/tech.py

@@ -1,9 +1,16 @@
 from .base import StatsFetcher
 import pandas as pd
+import yfinance as yf
 
 class TechFetcher(StatsFetcher):
     
     def __init__(self, ticker:str, db_client):
+
+        """
+        The Capitalization-Weighted Index includes the following tickers:
+        ['GSPC', 'IXIC', 'DJI', 'TWII']   
+        """
+        
         super().__init__(ticker, db_client)
         self.full_ohlcv = self._get_ohlcv()
         self.basic_indexes = ['SMA5', 'SMA20', 'SMA60', 'EMA5', 'EMA20', 
@@ -40,16 +47,36 @@ class TechFetcher(StatsFetcher):
         )
 
     def _get_ohlcv(self):
-        query = {'ticker': self.ticker}
-        ticker_full = list(self.collection.find(query))
+        
+        if self.ticker in ['GSPC', 'IXIC', 'DJI', 'TWII']:
+            
+            full_tick = f'^{self.ticker}'
+            yf_ticker = yf.Ticker(full_tick)
+            origin_df = yf_ticker.history(period="10y")
+            origin_df = origin_df.reset_index()
+            origin_df["Date"] = pd.to_datetime(origin_df["Date"]).dt.date
+            df = origin_df.rename(
+                columns={
+                    "Date": "date",
+                    "Open": "open",
+                    "High": "high",
+                    "Low": "low",
+                    "Close": "close",
+                    "Volume": "volume"
+                }
+            )
+        else:
+
+            query = {'ticker': self.ticker}
+            ticker_full = list(self.collection.find(query))
 
-        if not ticker_full:
-            raise ValueError(f"No data found for ticker: {self.ticker}")
+            if not ticker_full:
+                raise ValueError(f"No data found for ticker: {self.ticker}")
 
-        if 'daily_data' not in ticker_full[0] or ticker_full[0]['daily_data'] is None:
-            raise KeyError("Missing 'daily_data' in the retrieved data")
+            if 'daily_data' not in ticker_full[0] or ticker_full[0]['daily_data'] is None:
+                raise KeyError("Missing 'daily_data' in the retrieved data")
 
-        df = pd.DataFrame(ticker_full[0]['daily_data'])
+            df = pd.DataFrame(ticker_full[0]['daily_data'])
 
         selected_cols = ['date','open','high','low','close','volume']
 

neurostats_API-0.0.15/neurostats_API/fetchers/tej_finance_report.py

@@ -0,0 +1,313 @@
+from .base import BaseTEJFetcher
+from datetime import datetime
+from enum import Enum
+import pandas as pd
+from pymongo import MongoClient
+from ..utils import StatsProcessor, YoY_Calculator
+import warnings
+
+
+class FinanceReportFetcher(BaseTEJFetcher):
+    class FetchMode(Enum):
+        YOY = 1
+        QOQ = 2
+        YOY_NOCAL = 3
+        QOQ_NOCAL = 4
+
+    def __init__(self, mongo_uri, db_name = "company", collection_name = "TWN/AINVFQ1"):
+        self.client = MongoClient(mongo_uri)
+        self.db = self.client[db_name]
+        self.collection = self.db[collection_name]
+
+        self.check_index = {
+            'coid', 'mdate', 'key3', 'no',
+            'sem', 'merg', 'curr', 'annd',
+            'fin_ind', 'bp11', 'bp21', 'bp22',
+            'bp31', 'bp41', 'bp51', 'bp53',
+            'bp61', 'bp62', 'bp63', 'bp64',
+            'bp65', 'bf11', 'bf12', 'bf21',
+            'bf22', 'bf41', 'bf42', 'bf43',
+            'bf44', 'bf45', 'bf99', 'bsca',
+            'bsnca', 'bsta','bscl','bsncl',
+            'bstl','bsse','bslse','debt',
+            'quick','ppe','ar','ip12',
+            'ip22','ip31','ip51','iv41',
+            'if11','isibt','isni','isnip',
+            'eps','ispsd','gm','opi',
+            'nri','ri','nopi','ebit',
+            'cip31','cscfo','cscfi','cscff',
+            'person','shares','wavg','taxrate',
+            'r104','r115','r105','r106',
+            'r107','r108','r201','r112',
+            'r401','r402','r403','r404',
+            'r405','r408','r409','r410',
+            'r502','r501','r205','r505',
+            'r517','r512','r509','r608',
+            'r616','r610','r607','r613',
+            'r612','r609','r614','r611',
+            'r307','r304','r305','r306',
+            'r316','r834'
+        }
+
+    def get(
+        self, 
+        ticker, 
+        fetch_mode: FetchMode = FetchMode.QOQ,
+        start_date: str = None,
+        end_date: str = None,
+        report_type: str = "Q",
+        indexes: list = []
+    ):
+        """
+        基礎的query function
+        ticker(str): 股票代碼
+        start_date(str):  開頭日期範圍
+        end_date(str):  = 結束日期範圍
+        report_type(str): 報告型態 {"A", "Q", "TTM"}  
+        fetch_mode(class FetchMode): 
+           YoY : 起始日期到結束日期範圍內，特定該季的資料
+           QoQ : 起始日期到結束日期內，每季的資料(與上一季成長率)
+        indexes(List): 指定的index
+        """
+        # 確認indexes中是否有錯誤的index，有的話回傳warning
+        if (indexes and self.check_index):
+            indexes = set(indexes)
+            difference = indexes-self.check_index
+            if (difference):
+                warnings.warn(
+                    f"{list(difference)} 沒有出現在資料表中，請確認column名稱是否正確",
+                    UserWarning
+                )
+
+
+        if (fetch_mode in {
+                self.FetchMode.QOQ,
+                self.FetchMode.QOQ_NOCAL
+            }   
+        ):
+            if (not start_date):
+                warnings.warn("No start_date specified, use default date = \"2005-01-01\"", UserWarning)
+                start_date = datetime.strptime("2005-01-01", "%Y-%m-%d")      
+            if (not end_date):
+                warnings.warn("No end_date specified, use default date = today", UserWarning)
+                end_date = datetime.today()
+
+            assert (start_date <= end_date)
+            start_date = datetime.strptime(start_date, "%Y-%m-%d")
+            end_date = datetime.strptime(end_date, "%Y-%m-%d")
+
+            start_year = start_date.year
+            start_season = (start_date.month - 1) // 4 + 1
+            end_year = end_date.year
+            end_season = (end_date.month - 1) // 4 + 1
+
+            if (fetch_mode == self.FetchMode.QOQ):
+                use_cal = True
+            else:
+                use_cal = False
+
+            data_df = self.get_QoQ_data(
+                ticker=ticker,
+                start_year=start_year,
+                start_season=start_season,
+                end_year=end_year,
+                end_season=end_season,
+                report_type=report_type,
+                indexes=indexes,
+                use_cal=use_cal
+            )
+
+            return data_df
+
+        elif (fetch_mode in {
+                self.FetchMode.YOY,
+                self.FetchMode.YOY_NOCAL
+            }
+        ):
+            start_year = 2005
+            end_date = self.get_latest_data_time(ticker)
+            if (not end_date):
+                end_date = datetime.today()
+
+            end_year = end_date.year
+            season = (end_date.month - 1) // 4 + 1
+
+            if (fetch_mode == self.FetchMode.YOY):
+                use_cal = True
+            else:
+                use_cal = False
+
+            data_df = self.get_YoY_data(
+                ticker = ticker,
+                start_year = start_year,
+                end_year = end_year,
+                season = season,
+                report_type = report_type,
+                indexes = indexes
+            )
+        
+            return data_df
+
+    def get_QoQ_data(
+        self,
+        ticker,
+        start_year,
+        start_season,
+        end_year,
+        end_season,
+        report_type = "Q",
+        indexes = [],
+        use_cal = False
+    ):
+        """
+            取得時間範圍內每季資料
+        """
+        if (not indexes): # 沒有指定 -> 取全部
+            pipeline = [
+                { "$match": { "ticker": ticker } },
+                { "$unwind": "$data" },
+                { "$match": {
+                    "$or": [
+                        { "data.year": { "$gt": start_year, "$lt": end_year } },
+                        { "data.year": start_year, "data.season": { "$gte": start_season } },
+                        { "data.year": end_year, "data.season": { "$lte": end_season } }
+                    ]
+                }},
+                { "$project": {
+                    "data.year": 1,
+                    "data.season": 1,
+                    f"data.{report_type}": 1,
+                    "_id": 0
+                    } 
+                }
+            ]
+
+        
+        else: # 取指定index
+            project_stage = {
+                "data.year": 1,
+                "data.season": 1
+            }
+            for index in indexes:
+                project_stage[f"data.{report_type}.{index}"] = 1
+
+            pipeline = [
+                { "$match": { "ticker": ticker } },
+                { "$unwind": "$data" },
+                { "$match": {
+                    "$or": [
+                        { "data.year": { "$gt": start_year, "$lt": end_year } },
+                        { "data.year": start_year, "data.season": { "$gte": start_season } },
+                        { "data.year": end_year, "data.season": { "$lte": end_season } }
+                    ]
+                }},
+                { "$project": project_stage }
+            ]
+
+
+        fetched_data = self.collection.aggregate(pipeline).to_list()
+        
+        data_dict = StatsProcessor.list_of_dict_to_dict(
+            fetched_data,
+            keys = ["year", "season"],
+            delimeter = "Q",
+            data_key=report_type
+        )
+        if (use_cal):
+            data_with_QoQ = self.cal_QoQ(data_dict)
+            data_df = pd.DataFrame.from_dict(data_with_QoQ)
+        else:
+            data_df = pd.DataFrame.from_dict(data_dict)
+        return data_df
+    
+    def get_YoY_data(
+        self,
+        ticker,
+        start_year,
+        end_year,
+        season,
+        report_type = "Q",
+        indexes = [],
+        use_cal = False
+    ):
+        """
+        取得某季歷年資料
+        """
+        if (use_cal):
+            select_year = set()
+
+            for year in range(start_year, end_year + 1):
+                year_shifts = {
+                    year,
+                    year - 1,
+                    year - 3,
+                    year - 5,
+                    year - 10
+                }
+
+                select_year = select_year.union(year_shifts)
+            
+            select_year = sorted(list(select_year), reverse=True)
+        else:
+            select_year = [year for year in range(start_year, end_year + 1)]
+
+        if (not indexes): # 沒有指定 -> 取全部
+            pipeline = [
+                { "$match": { "ticker": ticker } },
+                { "$unwind": "$data" },
+                { "$match": {
+                    "$or":[
+                        {
+                            "$and": [
+                                { "data.year": {"$in": select_year }},
+                                { "data.season": {"$eq": season}}
+                            ]
+                        },
+                    ]
+                }},
+                { "$project": {
+                    "data.year": 1,
+                    "data.season": 1,
+                    f"data.{report_type}": 1, 
+                    "_id": 0 
+                    } 
+                }
+            ]
+
+        
+        else: # 取指定index
+            project_stage = {
+                "data.year": 1,
+                "data.season": 1
+            }
+            for index in indexes:
+                project_stage[f"data.{report_type}.{index}"] = 1
+
+            pipeline = [
+                { "$match": { "ticker": ticker } },
+                { "$unwind": "$data" },
+                { "$match": {
+                    "$and": [
+                                { "data.year": {"$in": select_year}},
+                                { "data.season": {"$eq": season}}
+                            ]
+                }},
+                { "$project": project_stage }
+            ]
+
+        fetched_data = self.collection.aggregate(pipeline).to_list()
+
+        # 處理計算YoY
+        data_dict = StatsProcessor.list_of_dict_to_dict(
+            fetched_data,
+            keys = ['year', 'season'],
+            data_key=report_type,
+            delimeter='Q'
+        )
+        if (use_cal):
+            data_with_YoY = self.cal_YoY(data_dict, start_year, end_year)
+            result_df = pd.DataFrame.from_dict(data_with_YoY)
+        else:
+            result_df = pd.DataFrame.from_dict(data_dict)
+
+        return result_df

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/neurostats_API/utils/__init__.py

@@ -1,4 +1,5 @@
 from .datetime import StatsDateTime
 from .db_client import DBClient
 from .data_process import StatsProcessor
-from .fetcher import StatsFetcher
+from .fetcher import StatsFetcher
+from .calculate_value import YoY_Calculator

neurostats_API-0.0.15/neurostats_API/utils/calculate_value.py

@@ -0,0 +1,26 @@
+class YoY_Calculator:
+    def __init__(self):
+        pass
+
+    @classmethod
+    def cal_growth(cls, target_value: float, past_value: float, delta: int):
+        """
+        計算成長率以及年化成長率
+        target_value: float，這個時間的數值
+        past_value: float，過去的這個時間數值
+        delta: int，代表隔了幾年/季 delta > 1 時改以年化成長率計算
+        """
+        try:
+            if (delta > 1):
+                YoY = ((target_value / past_value)**(1 / delta)) - 1
+
+            else:
+                YoY = ((target_value - past_value) / past_value)
+
+        except Exception as e:
+            return None
+
+        if (isinstance(YoY, complex)): # 年化成長率有複數問題
+            return None
+
+        return YoY

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/neurostats_API/utils/data_process.py

@@ -20,7 +20,6 @@ class StatsProcessor:
     """
     1. 讀檔: txt / yaml
     2. 將巢狀dictionary / DataFrame扁平化
-
     """
 
     @classmethod
@@ -215,3 +214,59 @@ class StatsProcessor:
             return int(np.round(value).item())
         else:
             return value
+    
+    @classmethod
+    def list_of_dict_to_dict(
+        cls,
+        data_list: list,
+        key: str = "",
+        keys: list = [],
+        delimeter: str = "_",
+        data_key: str = "Q"
+    ):
+        """
+        TEJ DB 用
+        List[Dict] -> Dict[Dict]
+        input:
+        data_list(List):
+            [
+                { "data":
+                    {
+                        "year": 2021...
+                        "season": 1,
+                        "Q": {}...
+                        
+                    }
+                }
+            ]
+        
+        key(str): 選擇哪一個key作為轉化後的index
+        delimeter(str): 多個key時要用甚麼分隔
+        return: 
+        {
+            "2021" : {# Q下的資料} ...
+        }
+
+        or  (keys = ['year', 'season'])
+        {
+            "2021Q2" : {}
+        }
+        """
+        assert (key or keys), "func list_of_dict_to_dict must have argument \"key\" or \"keys\""
+
+        return_dict = {}
+        if (key):
+            keys = [key]
+        for data in data_list:
+            data = data['data']
+
+            pop_keys = []
+
+            for key in keys:
+                assert (key in data.keys())
+                pop_keys.append(str(data.pop(key)))
+            
+            pop_key = delimeter.join(pop_keys)
+            return_dict[pop_key] = data[data_key]
+        
+        return return_dict

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: neurostats_API
-Version: 0.0.14
+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
@@ -83,7 +83,7 @@ pip install neurostats-API
 ```Python 
 >>> import neurostats_API
 >>> print(neurostats_API.__version__)
-0.0.14
+0.0.15
 ```
 
 ### 得到最新一期的評價資料與歷年評價
@@ -667,7 +667,66 @@ fetcher.query()
 
 請注意`range`, `last_range`, `52week_range`這三個項目型態為字串，其餘為float
 
+
+## TEJ 相關
+### 會計師簽證財務資料
+```Python
+from neurostats_API import FinanceReportFetcher
+
+mongo_uri = <MongoDB 的 URI>
+db_name = 'company' # 連接的DB名稱
+collection_name = "TWN/AINVFQ1" # 連接的collection對象
+
+fetcher = FinanceReportFetcher(
+    mongo_uri = mongo_uri,
+    db_name = db_name,
+    collection_name = collection_name
+)
+
+data = fetcher.get(
+    ticker = "2330" # 任意的股票代碼
+    fetch_mode = fetcher.YOY_NOCAL # 取得模式
+    start_date = "2005-01-01",
+    end_date = "2024-12-31",
+    report_type = "Q",
+    indexes = []
+)
+```
+- `ticker`: 股票代碼
+
+- `fetch_mode` : 取得模式，為`fetcher.YOY_NOCAL` 或 `fetcher.QOQ_NOCAL`
+    - `YOY_NOCAL`: 以end_date為準，取得與end_date為準同季的歷年資料，時間範圍以start_date為準
+        > 例如`start_date = "2020-07-01"`, `end_date = "2024-01-01"`，會回傳2020~2024的第一季資料
+
+    - `QOQ_NOCAL`: 時間範圍內的每季資料
+
+- `start_date`: 開始日期，不設定時預設為`2005-01-01`
+
+- `end_date`: 結束日期，不設定時預設為資料庫最新資料的日期
+
+- `report_type`: 選擇哪種報告，預設為`Q`
+    - `A`: 當年累計
+    - `Q`: 當季數值
+    - `TTM`: 移動四季 (包括當季在內，往前累計四個季度)
+
+- `indexes`: 選擇的column，需要以TEJ提供的欄位名稱為準，不提供時或提供`[]`會回傳全部column
+   - 範例輸入: `['bp41', 'bp51']`
+
+[TEJ資料集連結](https://tquant.tejwin.com/%E8%B3%87%E6%96%99%E9%9B%86/)
+請看 `會計師簽證財務資料`
+
+#### 回傳資料
+fetch_mode設定為`YOY_NOCAL`與`QOQ_NOCAL`下
+為回傳pd.DataFrame，column名稱為<年份>Q<季>， row名稱為指定財報項目
+
 ## 版本紀錄
+## 0.0.15
+- TechFetcher中新增指數條件
+
+- 新增tej_fetcher索取TEJ相關的資料
+
+- package新增depensnecy，可以安裝需要的相關package
+
 ## 0.0.14
 - 修改部分財報資料錯誤的乘以1000的問題
 

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/neurostats_API.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ neurostats_API/main.py
 neurostats_API.egg-info/PKG-INFO
 neurostats_API.egg-info/SOURCES.txt
 neurostats_API.egg-info/dependency_links.txt
+neurostats_API.egg-info/requires.txt
 neurostats_API.egg-info/top_level.txt
 neurostats_API/fetchers/__init__.py
 neurostats_API/fetchers/balance_sheet.py
@@ -18,6 +19,7 @@ neurostats_API/fetchers/margin_trading.py
 neurostats_API/fetchers/month_revenue.py
 neurostats_API/fetchers/profit_lose.py
 neurostats_API/fetchers/tech.py
+neurostats_API/fetchers/tej_finance_report.py
 neurostats_API/fetchers/value_invest.py
 neurostats_API/tools/balance_sheet.yaml
 neurostats_API/tools/cash_flow_percentage.yaml
@@ -25,8 +27,10 @@ neurostats_API/tools/finance_overview_dict.yaml
 neurostats_API/tools/profit_lose.yaml
 neurostats_API/tools/seasonal_data_field_dict.txt
 neurostats_API/utils/__init__.py
+neurostats_API/utils/calculate_value.py
 neurostats_API/utils/data_process.py
 neurostats_API/utils/datetime.py
 neurostats_API/utils/db_client.py
 neurostats_API/utils/fetcher.py
-test/test_fetchers.py
+test/test_fetchers.py
+test/test_tej.py

neurostats_API-0.0.15/neurostats_API.egg-info/requires.txt

@@ -0,0 +1,6 @@
+numpy>=2.1.0
+pandas>=2.2.0
+pymongo
+pytz
+python-dotenv
+yfinance

{neurostats_api-0.0.14 → neurostats_API-0.0.15}/setup.py

@@ -2,10 +2,16 @@ from setuptools import setup, find_packages
 
 setup(
     name='neurostats_API',
-    version='0.0.14',
+    version='0.0.15',
     long_description=open('README.md', 'r', encoding='utf-8').read(),
     long_description_content_type='text/markdown',
     install_requires=[
+        "numpy>=2.1.0",
+        "pandas>=2.2.0",
+        "pymongo",
+        "pytz",
+        "python-dotenv",
+        "yfinance"
     ],
     author='JasonWang@Neurowatt',
     packages=find_packages(exclude=['.venv', 'test*', 'data_in_db', '.pytest_cache']),

neurostats_API-0.0.15/test/test_tej.py

@@ -0,0 +1,26 @@
+import pytest
+
+mongo_uri = "mongodb+srv://admin:Neurowatt456&@axonnews-mongodb.nlui1.mongodb.net/?retryWrites=true&w=majority&appName=axonnews-mongodb"
+ticker = "2330"
+
+def test_QoQ():
+    from neurostats_API import FinanceReportFetcher
+
+    fetcher = FinanceReportFetcher(mongo_uri)
+
+    data = fetcher.get(
+        ticker,
+        fetch_mode = fetcher.FetchMode.QOQ_NOCAL,
+        start_date="2024-01-01",
+        end_date="2024-12-31",
+        indexes = ['bp41', 'bp51']
+    )
+
+    print(data)
+
+def test_YoY():
+    from neurostats_API import FinanceReportFetcher
+    fetcher = FinanceReportFetcher(mongo_uri)
+
+    data = fetcher.get(ticker, fetcher.FetchMode.YOY_NOCAL, indexes = ['bp41', 'bp51', 'arv'])
+    print (data)

neurostats_api-0.0.14/neurostats_API/__init__.py

@@ -1 +0,0 @@
-__version__='0.0.14'

neurostats_api-0.0.14/neurostats_API/fetchers/base.py

@@ -1,54 +0,0 @@
-from pymongo import MongoClient
-import pandas as pd
-import json
-import pytz
-from datetime import datetime, timedelta, date
-from ..utils import StatsDateTime, StatsProcessor
-import yaml
-
-class StatsFetcher:
-    def __init__(self, ticker, db_client):
-        self.ticker = ticker
-        self.db = db_client[
-            "company"]  # Replace with your database name
-        self.collection = self.db["twse_stats"]
-
-        self.timezone = pytz.timezone("Asia/Taipei")
-
-        self.target_metric_dict = {
-            'value': ['value'],
-            'value_and_percentage': ['value', 'percentage'],
-            'percentage': ['percentage'],
-            'grand_total': ['grand_total'],
-            'grand_total_values': ['grand_total', 'grand_total_percentage'],
-            'grand_total_percentage': ['grand_total_percentage'],
-            'growth': [f'YoY_{i}' for i in [1, 3, 5, 10]],
-            'grand_total_growth': [f"YoY_{i}" for i in [1, 3, 5, 10]]
-        }
-
-
-    def prepare_query(self):
-        return [
-            {
-                "$match": {
-                    "ticker": self.ticker,
-                }
-            },
-        ]
-
-    def collect_data(self, start_date, end_date):
-        pipeline = self.prepare_query(start_date, end_date)
-
-        fetched_data = list(self.collection.aggregate(pipeline))
-
-        return fetched_data[0]
-
-    def str_to_datetime(self, date_str):
-        year, month, day = [int(num) for num in date_str.split("-")]
-
-        date = datetime.strptime(date_str, "%Y-%m-%d")
-        date = self.timezone.localize(date)
-
-        season = (month - 1) // 3 + 1
-
-        return StatsDateTime(date, year, month, day, season)