neurostats-API 0.0.3__tar.gz → 0.0.5__tar.gz

neurostats_api-0.0.5/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include neurostats_api/tools *.yaml
+recursive-include neurostats_api/tools *.txt

{neurostats_API-0.0.3 → neurostats_api-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neurostats_API
-Version: 0.0.3
+Version: 0.0.5
 Summary: The service of NeuroStats website
 Home-page: https://github.com/NeurowattStats/NeuroStats_API.git
 Author: JasonWang@Neurowatt
@@ -12,46 +12,78 @@ Description-Content-Type: text/markdown
 
 - [檔案架構](#檔案架構)
 - [使用方法](#使用方法)
-    - [import](#import)
+    - [下載](#下載)
     - [價值投資](#得到最新一期的評價資料與歷年評價)
     - [財務分析-重要指標](#財務分析-重要指標)
     - [月營收表](#回傳月營收表)
+    - [損益表](#損益表)
     - [資產負債表](#資產負債表)
     - [現金流量表](#現金流量表)
 
 ## 檔案架構
 
 ```
-./
-├── cli.py
-├── main.py
+├── neurostats_API
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── main.py
+│   ├── fetchers
+│   │   ├── __init__.py
+│   │   ├── base.py
+│   │   ├── finance_overview.py
+│   │   ├── tech.py
+│   │   └── value_invest.py
+│   ├── tools
+│   │   ├── finance_overview_dict.yaml
+│   │   ├── profit_lose.yaml
+│   │   └── seasonal_data_field_dict.txt
+│   └── utils
+│       ├──__init__.py
+│       ├── data_process.py
+│       ├── datetime.py
+│       ├── db_client.py
+│       └── fetcher.py
+├──  test
+│    ├── __init__.py
+│    └── test_fetchers.py
+├── Makefile
+├── MANIFEST.in
 ├── README.md
 ├── requirement.txt
-├── tw50_company_list.json
-└── utils
-    ├── fetcher.py
-    ├── __init__.py
-```
-
-`main.py`: 執行檔
-`cli.py`: 命令輸入的檔案
-`utils`: 存放fetcher
-- `fetcher.py`: Service的主架構
-`tw50_company_list.json`: tw50的公司列表
-
-## 使用方法
+├── setup.py
 
-### import
-```Python
-from utils import statsFetcher
-stats_fetcher = statsFetcher
+```
+- `neurostats_API`: 主要的package運行內容
+   - `fetchers`: 回傳service內容的fetcher檔案夾
+      - `base.py`: 基本架構
+      - `value_invest.py`: iFa.ai -> 價值投資
+      - `finance_overview.py`: iFa.ai -> 財務分析 -> 重要指標
+      - `tech.py`: iFa.ai -> 技術指標
+   - `tools`: 存放各種設定檔與資料庫index對應領域的dictionary
+   - `utils`: 
+      - `fetcher.py`: Service的舊主架構, 月營收, 損益表, 資產負債表, 資產收益表目前在這裡
+      - `data_process.py`: config資料的讀取
+      - `datetime.py`: 時間格式，包括日期,年度,月份,日,季度
+
+## 下載
+```
+pip install neurostats-API
+```
+### 確認下載成功
+```Python 
+>>> import neurostats_API
+>>> print(neurostats_API.__version__)
+0.0.5
 ```
 
 ### 得到最新一期的評價資料與歷年評價
 ``` Python
+from neurostats_API.fetchers import ValueFetcher
 ticker = 2330 # 換成tw50內任意ticker
-stats_fetcher.get_value_sheet(ticker)
+fetcher = ValueFetcher(ticker)
+data = stats_fetcher.query_data()
 ```
+
 #### 回傳(2330為例)
 ```Python
 {
@@ -86,8 +118,10 @@ stats_fetcher.get_value_sheet(ticker)
 
 ### 回傳月營收表
 ``` Python
+from neurostats_API.utils import StatsFetcher
 ticker = 2330 # 換成tw50內任意ticker
-stats_fetcher.get_month_revenue_sheet(ticker)
+fetcher = StatsFetcher()
+data = stats_fetcher.get_month_revenue_sheet(ticker)
 ```
 
 #### 回傳
@@ -136,9 +170,10 @@ YoY_10          None         None  ...           None           None
 ### 財務分析: 重要指標
 對應https://ifa.ai/tw-stock/2330/finance-overview
 ```Python
-from fetchers import FinanceOverviewFetcher
-fetcher = FinanceOverviewFetcher(2330) # 參數內可換成其他股票代碼
-fetcher.query_data()
+from neurostats_API.fetchers import FinanceOverviewFetcher
+ticker = "2330"
+fetcher = FinanceOverviewFetcher(ticker = "2330")
+data = fetcher.query_data()
 ```
 
 #### 回傳
@@ -218,8 +253,10 @@ markdown
 
 ### 損益表
 ```Python
+from neurostats_API.utils import StatsFetcher
+fetcher = StatsFetcher()
 ticker = 2330 # 換成tw50內任意ticker
-stats_fetcher.get_profit_lose(ticker)
+data = fetcher.get_profit_lose(ticker)
 ```
    
 #### 回傳
@@ -264,6 +301,8 @@ stats_fetcher.get_profit_lose(ticker)
 
 ### 資產負債表
 ``` Python
+from neurostats_API.utils import StatsFetcher
+fetcher = StatsFetcher()
 ticker = 2330 # 換成tw50內任意ticker
 stats_fetcher.get_balance_sheet(ticker)
 ```
@@ -321,6 +360,8 @@ equity  1.094370e+09               53.3  ...  3.390706e+09              56.68
 
 ### 現金流量表
 ``` Python
+from neurostats_API.utils import StatsFetcher
+fetcher = StatsFetcher()
 ticker = 2330 # 換成tw50內任意ticker
 stats_fetcher.get_cash_flow(ticker)
 ```
@@ -400,6 +441,9 @@ stats_fetcher.get_cash_flow(ticker)
 
 > 大部分資料缺失是因為尚未計算，僅先填上已經有的資料
 
+
+
+
 ## cli 範例輸入
 ```
 python ./cli.py --ticker 1101
@@ -437,4 +481,5 @@ daily_data
 > 這裡有Nan是因為本益比與P/B等資料沒有爬到最新的時間
 
 ## TODO
+- 將utils/fetcher.py中的功能切分到fetchers資料夾中
 

neurostats_API-0.0.3/neurostats_API.egg-info/PKG-INFO → neurostats_api-0.0.5/README.md

@@ -1,57 +1,79 @@
-Metadata-Version: 2.1
-Name: neurostats-API
-Version: 0.0.3
-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
 
 - [檔案架構](#檔案架構)
 - [使用方法](#使用方法)
-    - [import](#import)
+    - [下載](#下載)
     - [價值投資](#得到最新一期的評價資料與歷年評價)
     - [財務分析-重要指標](#財務分析-重要指標)
     - [月營收表](#回傳月營收表)
+    - [損益表](#損益表)
     - [資產負債表](#資產負債表)
     - [現金流量表](#現金流量表)
 
 ## 檔案架構
 
 ```
-./
-├── cli.py
-├── main.py
+├── neurostats_API
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── main.py
+│   ├── fetchers
+│   │   ├── __init__.py
+│   │   ├── base.py
+│   │   ├── finance_overview.py
+│   │   ├── tech.py
+│   │   └── value_invest.py
+│   ├── tools
+│   │   ├── finance_overview_dict.yaml
+│   │   ├── profit_lose.yaml
+│   │   └── seasonal_data_field_dict.txt
+│   └── utils
+│       ├──__init__.py
+│       ├── data_process.py
+│       ├── datetime.py
+│       ├── db_client.py
+│       └── fetcher.py
+├──  test
+│    ├── __init__.py
+│    └── test_fetchers.py
+├── Makefile
+├── MANIFEST.in
 ├── README.md
 ├── requirement.txt
-├── tw50_company_list.json
-└── utils
-    ├── fetcher.py
-    ├── __init__.py
-```
-
-`main.py`: 執行檔
-`cli.py`: 命令輸入的檔案
-`utils`: 存放fetcher
-- `fetcher.py`: Service的主架構
-`tw50_company_list.json`: tw50的公司列表
+├── setup.py
 
-## 使用方法
-
-### import
-```Python
-from utils import statsFetcher
-stats_fetcher = statsFetcher
+```
+- `neurostats_API`: 主要的package運行內容
+   - `fetchers`: 回傳service內容的fetcher檔案夾
+      - `base.py`: 基本架構
+      - `value_invest.py`: iFa.ai -> 價值投資
+      - `finance_overview.py`: iFa.ai -> 財務分析 -> 重要指標
+      - `tech.py`: iFa.ai -> 技術指標
+   - `tools`: 存放各種設定檔與資料庫index對應領域的dictionary
+   - `utils`: 
+      - `fetcher.py`: Service的舊主架構, 月營收, 損益表, 資產負債表, 資產收益表目前在這裡
+      - `data_process.py`: config資料的讀取
+      - `datetime.py`: 時間格式，包括日期,年度,月份,日,季度
+
+## 下載
+```
+pip install neurostats-API
+```
+### 確認下載成功
+```Python 
+>>> import neurostats_API
+>>> print(neurostats_API.__version__)
+0.0.5
 ```
 
 ### 得到最新一期的評價資料與歷年評價
 ``` Python
+from neurostats_API.fetchers import ValueFetcher
 ticker = 2330 # 換成tw50內任意ticker
-stats_fetcher.get_value_sheet(ticker)
+fetcher = ValueFetcher(ticker)
+data = stats_fetcher.query_data()
 ```
+
 #### 回傳(2330為例)
 ```Python
 {
@@ -86,8 +108,10 @@ stats_fetcher.get_value_sheet(ticker)
 
 ### 回傳月營收表
 ``` Python
+from neurostats_API.utils import StatsFetcher
 ticker = 2330 # 換成tw50內任意ticker
-stats_fetcher.get_month_revenue_sheet(ticker)
+fetcher = StatsFetcher()
+data = stats_fetcher.get_month_revenue_sheet(ticker)
 ```
 
 #### 回傳
@@ -136,9 +160,10 @@ YoY_10          None         None  ...           None           None
 ### 財務分析: 重要指標
 對應https://ifa.ai/tw-stock/2330/finance-overview
 ```Python
-from fetchers import FinanceOverviewFetcher
-fetcher = FinanceOverviewFetcher(2330) # 參數內可換成其他股票代碼
-fetcher.query_data()
+from neurostats_API.fetchers import FinanceOverviewFetcher
+ticker = "2330"
+fetcher = FinanceOverviewFetcher(ticker = "2330")
+data = fetcher.query_data()
 ```
 
 #### 回傳
@@ -218,8 +243,10 @@ markdown
 
 ### 損益表
 ```Python
+from neurostats_API.utils import StatsFetcher
+fetcher = StatsFetcher()
 ticker = 2330 # 換成tw50內任意ticker
-stats_fetcher.get_profit_lose(ticker)
+data = fetcher.get_profit_lose(ticker)
 ```
    
 #### 回傳
@@ -264,6 +291,8 @@ stats_fetcher.get_profit_lose(ticker)
 
 ### 資產負債表
 ``` Python
+from neurostats_API.utils import StatsFetcher
+fetcher = StatsFetcher()
 ticker = 2330 # 換成tw50內任意ticker
 stats_fetcher.get_balance_sheet(ticker)
 ```
@@ -321,6 +350,8 @@ equity  1.094370e+09               53.3  ...  3.390706e+09              56.68
 
 ### 現金流量表
 ``` Python
+from neurostats_API.utils import StatsFetcher
+fetcher = StatsFetcher()
 ticker = 2330 # 換成tw50內任意ticker
 stats_fetcher.get_cash_flow(ticker)
 ```
@@ -400,6 +431,9 @@ stats_fetcher.get_cash_flow(ticker)
 
 > 大部分資料缺失是因為尚未計算，僅先填上已經有的資料
 
+
+
+
 ## cli 範例輸入
 ```
 python ./cli.py --ticker 1101
@@ -437,4 +471,5 @@ daily_data
 > 這裡有Nan是因為本益比與P/B等資料沒有爬到最新的時間
 
 ## TODO
+- 將utils/fetcher.py中的功能切分到fetchers資料夾中
 

neurostats_api-0.0.5/neurostats_API/__init__.py

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

neurostats_api-0.0.5/neurostats_API/fetchers/__init__.py

@@ -0,0 +1,3 @@
+from .base import StatsDateTime, StatsFetcher
+from .finance_overview import FinanceOverviewFetcher
+from .value_invest import ValueFetcher

{neurostats_API-0.0.3 → neurostats_api-0.0.5}/neurostats_API/fetchers/base.py

@@ -3,15 +3,13 @@ import pandas as pd
 import json
 import pytz
 from datetime import datetime, timedelta, date
-from utils import StatsDateTime
+from ..utils import StatsDateTime, StatsProcessor
 import yaml
-from .utils.db_client import shared_client 
 
 class StatsFetcher:
-
-    def __init__(self, ticker):
+    def __init__(self, ticker, db_client):
         self.ticker = ticker
-        self.db = shared_client[
+        self.db = db_client[
             "company"]  # Replace with your database name
         self.collection = self.db["twse_stats"]
 
@@ -28,6 +26,7 @@ class StatsFetcher:
             'grand_total_growth': [f"YoY_{i}" for i in [1, 3, 5, 10]]
         }
 
+
     def prepare_query(self):
         return [
             {
@@ -53,7 +52,3 @@ class StatsFetcher:
         season = (month - 1) // 3 + 1
 
         return StatsDateTime(date, year, month, day, season)
-
-
-class StatsProcessor:
-    pass

{neurostats_API-0.0.3 → neurostats_api-0.0.5}/neurostats_API/fetchers/finance_overview.py

@@ -1,7 +1,8 @@
-from .base import StatsFetcher, StatsProcessor, StatsDateTime
+from .base import StatsFetcher, StatsDateTime
 import json
 import pandas as pd
-from utils import StatsDateTime
+from ..utils import StatsDateTime, StatsProcessor
+import importlib.resources as pkg_resources
 import yaml
 
 
@@ -10,14 +11,11 @@ class FinanceOverviewFetcher(StatsFetcher):
     對應iFa.ai -> 財務分析 -> 重要指標(finance_overview)
     """
 
-    def __init__(self, ticker):
-        super().__init__(ticker)
+    def __init__(self, ticker, db_client):
+        super().__init__(ticker, db_client)
 
-        with open("./tools/finance_overview_dict.yaml") as f:
-            self.target_fields = yaml.safe_load(f)
-
-        with open("./tools/seasonal_data_field_dict.txt") as f:
-            self.inverse_dict = json.load(f)
+        self.target_fields = StatsProcessor.load_yaml("finance_overview_dict.yaml")
+        self.inverse_dict = StatsProcessor.load_txt("seasonal_data_field_dict.txt", json_load=True)
 
     def prepare_query(self, target_year, target_season):
 

{neurostats_API-0.0.3 → neurostats_api-0.0.5}/neurostats_API/fetchers/tech.py

@@ -3,9 +3,8 @@ import pandas as pd
 
 class TechFetcher(StatsFetcher):
     
-    def __init__(self, ticker:str):
-        super().__init__()
-        self.ticker = ticker
+    def __init__(self, ticker:str, db_client):
+        super().__init__(ticker, db_client)
         self.full_ohlcv = self._get_ohlcv()
         self.basic_indexes = ['SMA5', 'SMA20', 'SMA60', 'EMA5', 'EMA20', 
                               'EMA40', 'EMA12', 'EMA26', 'RSI7', 'RSI14',

{neurostats_API-0.0.3 → neurostats_api-0.0.5}/neurostats_API/fetchers/value_invest.py

@@ -1,13 +1,13 @@
-from .base import StatsFetcher, StatsProcessor
+from .base import StatsFetcher
 from datetime import datetime, timedelta, date
 import pandas as pd
-from utils import StatsDateTime
+from ..utils import StatsDateTime, StatsProcessor
 
 
 class ValueFetcher(StatsFetcher):
 
-    def __init__(self, ticker: str):
-        super().__init__(ticker)
+    def __init__(self, ticker: str, db_client):
+        super().__init__(ticker, db_client)
 
     def prepare_query(self, start_date, end_date):
         pipeline = super().prepare_query()

neurostats_api-0.0.5/neurostats_API/tools/finance_overview_dict.yaml

@@ -0,0 +1,136 @@
+# 財務概況
+revenue:
+  field: 營業收入合計
+  value: value
+
+gross_profit:
+  field: 營業毛利（毛損）淨額
+  value: value
+
+operating_income:
+  field: 營業利益（損失）
+  value: value
+
+net_income:
+  field: 本期淨利（淨損）
+  value: value
+
+# TODO: 以下所爬到的資料都是累計的，Ifa有額外計算當季的變化量
+operating_cash_flow:
+  field: 營業活動之淨現金流入（流出）
+  value: value
+
+invest_cash_flow:
+  field: 投資活動之淨現金流入（流出）
+  value: value
+
+financing_cash_flow:
+  field: 籌資活動之淨現金流入（流出）
+  value: value
+
+fcf:
+  field: 本期現金及約當現金增加（減少）數
+  value: value
+# ^^^ 以上皆需要額外在DataBase處理
+
+# 每股財務狀況
+capital:
+  field: 普通股股本
+  value: value
+eps:
+  field: 基本每股盈餘
+  value: value
+
+# 獲利能力
+total_asset:
+  field: 資產總額
+  value: value
+
+equity:
+  field: 權益總額
+  value: value
+
+net_income_before_tax:
+  field: 稅前淨利（淨損）
+  value: value
+
+interest:
+  field: 利息收入
+  value: value
+
+operating_expenses:
+  field: 營業費用合計
+  value: value
+
+net_income_rate:
+  field: 本期淨利（淨損）
+  value: percentage
+# 成長動能
+revenue_YoY:
+  field: 營業收入合計
+  value: YoY_1
+
+gross_prof_YoY:
+  field: 營業毛利（毛損）淨額
+  value: YoY_1
+
+operating_income_YoY:
+  field: 營業利益（損失）
+  value: YoY_1
+
+net_income_YoY:
+  field: 本期淨利（淨損）
+  value: YoY_1
+
+operating_cash_flow_YoY:
+  field: 營業活動之淨現金流入（流出）
+  value: YoY_1
+
+# operating_cash_flow_per_share_YoY:
+#   field: 每股營業現金流年成長率
+#   value: YoY_1
+# 營運指標
+account_receive:
+  field: 應收帳款淨額
+  value: value
+
+account_pay:
+  field: 應付帳款
+  value: value
+
+inventories:
+  field: 存貨
+  value: value
+
+operating_cost:
+  field: 營業成本合計
+  value: value
+
+application:
+  field: 不動產、廠房及設備
+  value: value
+
+# 財務韌性
+current_assets:
+  field: 流動資產合計
+  value: value
+
+current_liabilities:
+  field: 流動負債合計
+  value: value
+
+total_liabilities:
+  field: 負債總額
+  value: value
+
+# 
+cash_and_cash_equivalents:
+  field: 現金及約當現金
+  value: value
+
+interest_expense: 
+  field: 利息費用
+  value: value
+
+
+

neurostats_api-0.0.5/neurostats_API/tools/profit_lose.yaml

@@ -0,0 +1,93 @@
+profit_lose:  # 總營收表
+  mode: value_and_percentage
+
+grand_total_profit_lose:
+  mode: grand_total_values
+
+revenue:
+  mode: growth
+  target_index: 營業收入合計
+
+grand_total_revenue:
+  mode: grand_total_values
+  target_index: 營業收入合計 
+
+gross_profit:
+  mode: growth
+  target_index: 營業毛利（毛損）淨額
+
+grand_total_gross_profit:
+  mode: grand_total_growth
+  target_index: 營業毛利（毛損）淨額
+
+gross_profit_percentage:
+  mode: percentage
+  target_index: 營業毛利（毛損）淨額
+
+grand_total_gross_profit_percentage:
+  mode: grand_total_percentage
+  target_index: 營業毛利（毛損）淨額
+# 營利
+operating_income:
+  mode: growth
+  target_index: 營業利益（損失）
+
+grand_total_operating_income:
+  mode: grand_total_growth
+  target_index: 營業利益（損失）
+
+operating_income_percentage:
+  mode: percentage
+  target_index: 營業利益（損失）
+
+grand_total_operating_income_percentage:
+  mode: grand_total_percentage
+  target_index: 營業利益（損失）
+# 稅前淨利
+net_income_before_tax:
+  mode: growth
+  target_index: 稅前淨利（淨損）
+
+grand_total_net_income_before_tax:
+  mode: grand_total_growth
+  target_index: 稅前淨利（淨損）
+
+net_income_before_tax_percentage:
+  mode: percentage
+  target_index: 稅前淨利（淨損）
+
+grand_total_net_income_before_tax_percentage:
+  mode: grand_total_percentage
+  target_index: 稅前淨利（淨損）
+# 本期淨利
+net_income:
+  mode: growth
+  target_index: 本期淨利（淨損）
+
+grand_total_net_income:
+  mode: grand_total_growth
+  target_index: 本期淨利（淨損）
+
+net_income_percentage:
+  mode: percentage
+  target_index: 本期淨利（淨損）
+
+grand_total_income_percentage:
+  mode: grand_total_percentage
+  target_index: 本期淨利（淨損）
+# EPS
+EPS:
+  mode: value
+  target_index: 稀釋每股盈餘
+
+EPS_growth:
+  mode: growth
+  target_index: 稀釋每股盈餘
+
+grand_total_EPS:
+  mode: grand_total
+  target_index: 稀釋每股盈餘
+
+grand_total_EPS_growth:
+  mode: grand_total_growth
+  target_index: 稀釋每股盈餘