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

neurostats_API-0.0.4/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.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neurostats_API
-Version: 0.0.3
+Version: 0.0.4
 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-0.0.4}/README.md

@@ -2,46 +2,78 @@
 
 - [檔案架構](#檔案架構)
 - [使用方法](#使用方法)
-    - [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
 {
@@ -76,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)
 ```
 
 #### 回傳
@@ -126,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()
 ```
 
 #### 回傳
@@ -208,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)
 ```
    
 #### 回傳
@@ -254,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)
 ```
@@ -311,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)
 ```
@@ -390,6 +431,9 @@ stats_fetcher.get_cash_flow(ticker)
 
 > 大部分資料缺失是因為尚未計算，僅先填上已經有的資料
 
+
+
+
 ## cli 範例輸入
 ```
 python ./cli.py --ticker 1101
@@ -427,4 +471,5 @@ daily_data
 > 這裡有Nan是因為本益比與P/B等資料沒有爬到最新的時間
 
 ## TODO
+- 將utils/fetcher.py中的功能切分到fetchers資料夾中
 

neurostats_API-0.0.4/neurostats_API/__init__.py

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

neurostats_API-0.0.4/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.4}/neurostats_API/fetchers/base.py

@@ -3,9 +3,10 @@ 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 
+from ..utils import shared_client 
+
 
 class StatsFetcher:
 
@@ -28,6 +29,7 @@ class StatsFetcher:
             'grand_total_growth': [f"YoY_{i}" for i in [1, 3, 5, 10]]
         }
 
+
     def prepare_query(self):
         return [
             {
@@ -53,7 +55,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.4}/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
 
 
@@ -13,11 +14,8 @@ class FinanceOverviewFetcher(StatsFetcher):
     def __init__(self, ticker):
         super().__init__(ticker)
 
-        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.4}/neurostats_API/fetchers/value_invest.py

@@ -1,7 +1,7 @@
-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):

neurostats_API-0.0.4/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.4/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: 稀釋每股盈餘

neurostats_API-0.0.4/neurostats_API/tools/seasonal_data_field_dict.txt

@@ -0,0 +1,158 @@
+{
+  "現金及約當現金": "balance_sheet",
+  "透過損益按公允價值衡量之金融資產－流動": "balance_sheet",
+  "透過其他綜合損益按公允價值衡量之金融資產－流動": "balance_sheet",
+  "備供出售金融資產－流動淨額": "balance_sheet",
+  "應收票據淨額": "balance_sheet",
+  "應收帳款淨額": "balance_sheet",
+  "應收帳款－關係人淨額": "balance_sheet",
+  "其他應收款淨額": "balance_sheet",
+  "其他應收款－關係人淨額": "balance_sheet",
+  "本期所得稅資產": "balance_sheet",
+  "存貨": "balance_sheet",
+  "預付款項": "balance_sheet",
+  "其他流動資產": "balance_sheet",
+  "流動資產合計": "balance_sheet",
+  "以成本衡量之金融資產－非流動淨額": "balance_sheet",
+  "採用權益法之投資淨額": "balance_sheet",
+  "不動產、廠房及設備": "balance_sheet",
+  "投資性不動產淨額": "balance_sheet",
+  "無形資產": "balance_sheet",
+  "遞延所得稅資產": "balance_sheet",
+  "其他非流動資產": "balance_sheet",
+  "非流動資產合計": "balance_sheet",
+  "資產總額": "balance_sheet",
+  "短期借款": "balance_sheet",
+  "透過損益按公允價值衡量之金融負債－流動": "balance_sheet",
+  "應付票據": "balance_sheet",
+  "應付帳款": "balance_sheet",
+  "應付帳款－關係人": "balance_sheet",
+  "其他應付款": "balance_sheet",
+  "其他應付款項－關係人": "balance_sheet",
+  "本期所得稅負債": "balance_sheet",
+  "負債準備－流動": "balance_sheet",
+  "其他流動負債": "balance_sheet",
+  "流動負債合計": "balance_sheet",
+  "遞延所得稅負債": "balance_sheet",
+  "其他非流動負債": "balance_sheet",
+  "非流動負債合計": "balance_sheet",
+  "負債總額": "balance_sheet",
+  "普通股股本": "balance_sheet",
+  "股本合計": "balance_sheet",
+  "資本公積－發行溢價": "balance_sheet",
+  "資本公積－其他": "balance_sheet",
+  "資本公積合計": "balance_sheet",
+  "法定盈餘公積": "balance_sheet",
+  "特別盈餘公積": "balance_sheet",
+  "未分配盈餘（或待彌補虧損）": "balance_sheet",
+  "保留盈餘合計": "balance_sheet",
+  "其他權益合計": "balance_sheet",
+  "庫藏股票": "balance_sheet",
+  "歸屬於母公司業主之權益合計": "balance_sheet",
+  "非控制權益": "balance_sheet",
+  "權益總額": "balance_sheet",
+  "負債及權益總計": "balance_sheet",
+  "待註銷股本股數（單位：股）": "balance_sheet",
+  "預收股款（權益項下）之約當發行股數（單位：股）": "balance_sheet",
+  "母公司暨子公司所持有之母公司庫藏股股數（單位：股）": "balance_sheet",
+  "繼續營業單位稅前淨利（淨損）": "cash_flow",
+  "停業單位稅前淨利（淨損）": "cash_flow",
+  "本期稅前淨利（淨損）": "cash_flow",
+  "折舊費用": "cash_flow",
+  "攤銷費用": "cash_flow",
+  "透過損益按公允價值衡量金融資產及負債之淨損失（利益）": "cash_flow",
+  "利息費用": "cash_flow",
+  "利息收入": "cash_flow",
+  "採用權益法認列之關聯企業及合資損失（利益）之份額": "cash_flow",
+  "處分及報廢不動產、廠房及設備損失（利益）": "cash_flow",
+  "不動產、廠房及設備轉列費用數": "cash_flow",
+  "處分無形資產損失（利益）": "cash_flow",
+  "處分投資損失（利益）": "cash_flow",
+  "處分採用權益法之投資損失（利益）": "cash_flow",
+  "未實現銷貨利益（損失）": "cash_flow",
+  "已實現銷貨損失（利益）": "cash_flow",
+  "未實現外幣兌換損失（利益）": "cash_flow",
+  "收益費損項目合計": "cash_flow",
+  "強制透過損益按公允價值衡量之金融資產（增加）減少": "cash_flow",
+  "應收票據（增加）減少": "cash_flow",
+  "應收帳款（增加）減少": "cash_flow",
+  "存貨（增加）減少": "cash_flow",
+  "其他流動資產（增加）減少": "cash_flow",
+  "其他營業資產（增加）減少": "cash_flow",
+  "與營業活動相關之資產之淨變動合計": "cash_flow",
+  "應付票據增加（減少）": "cash_flow",
+  "應付帳款增加（減少）": "cash_flow",
+  "其他流動負債增加（減少）": "cash_flow",
+  "淨確定福利負債增加(減少)": "cash_flow",
+  "與營業活動相關之負債之淨變動合計": "cash_flow",
+  "與營業活動相關之資產及負債之淨變動合計": "cash_flow",
+  "調整項目合計": "cash_flow",
+  "營運產生之現金流入（流出）": "cash_flow",
+  "收取之利息": "cash_flow",
+  "支付之利息": "cash_flow",
+  "退還（支付）之所得稅": "cash_flow",
+  "營業活動之淨現金流入（流出）": "cash_flow",
+  "取得透過其他綜合損益按公允價值衡量之金融資產": "cash_flow",
+  "處分透過其他綜合損益按公允價值衡量之金融資產": "cash_flow",
+  "取得備供出售金融資產": "cash_flow",
+  "處分備供出售金融資產": "cash_flow",
+  "取得採用權益法之投資": "cash_flow",
+  "處分採用權益法之投資": "cash_flow",
+  "取得不動產、廠房及設備": "cash_flow",
+  "處分不動產、廠房及設備": "cash_flow",
+  "存出保證金增加": "cash_flow",
+  "存出保證金減少": "cash_flow",
+  "取得無形資產": "cash_flow",
+  "其他非流動資產增加": "cash_flow",
+  "收取之股利": "cash_flow",
+  "投資活動之淨現金流入（流出）": "cash_flow",
+  "短期借款增加": "cash_flow",
+  "短期借款減少": "cash_flow",
+  "存入保證金增加": "cash_flow",
+  "存入保證金減少": "cash_flow",
+  "發放現金股利": "cash_flow",
+  "其他籌資活動": "cash_flow",
+  "籌資活動之淨現金流入（流出）": "cash_flow",
+  "匯率變動對現金及約當現金之影響": "cash_flow",
+  "本期現金及約當現金增加（減少）數": "cash_flow",
+  "期初現金及約當現金餘額": "cash_flow",
+  "期末現金及約當現金餘額": "cash_flow",
+  "資產負債表帳列之現金及約當現金": "cash_flow",
+  "其他符合國際會計準則第七號現金及約當現金定義之項目": "cash_flow",
+  "銷貨收入": "profit_lose",
+  "銷貨退回": "profit_lose",
+  "銷貨折讓": "profit_lose",
+  "銷貨收入淨額": "profit_lose",
+  "營業收入合計": "profit_lose",
+  "銷貨成本": "profit_lose",
+  "營業成本合計": "profit_lose",
+  "營業毛利（毛損）": "profit_lose",
+  "未實現銷貨（損）益": "profit_lose",
+  "已實現銷貨（損）益": "profit_lose",
+  "營業毛利（毛損）淨額": "profit_lose",
+  "推銷費用": "profit_lose",
+  "管理費用": "profit_lose",
+  "研究發展費用": "profit_lose",
+  "營業費用合計": "profit_lose",
+  "營業利益（損失）": "profit_lose",
+  "其他收入": "profit_lose",
+  "其他利益及損失淨額": "profit_lose",
+  "採用權益法認列之關聯企業及合資損益之份額淨額": "profit_lose",
+  "營業外收入及支出合計": "profit_lose",
+  "稅前淨利（淨損）": "profit_lose",
+  "所得稅費用（利益）合計": "profit_lose",
+  "繼續營業單位本期淨利（淨損）": "profit_lose",
+  "本期淨利（淨損）": "profit_lose",
+  "確定福利計畫之再衡量數": "profit_lose",
+  "透過其他綜合損益按公允價值衡量之權益工具投資未實現評價損益": "profit_lose",
+  "國外營運機構財務報表換算之兌換差額": "profit_lose",
+  "備供出售金融資產未實現評價損益": "profit_lose",
+  "其他綜合損益（淨額）": "profit_lose",
+  "本期綜合損益總額": "profit_lose",
+  "母公司業主（淨利∕損）": "profit_lose",
+  "非控制權益（淨利∕損）": "profit_lose",
+  "母公司業主（綜合損益）": "profit_lose",
+  "非控制權益（綜合損益）": "profit_lose",
+  "基本每股盈餘": "profit_lose",
+  "稀釋每股盈餘": "profit_lose"
+}

neurostats_API-0.0.4/neurostats_API/utils/__init__.py

@@ -0,0 +1,4 @@
+from .datetime import StatsDateTime
+from .db_client import shared_client
+from .data_process import StatsProcessor
+from .fetcher import StatsFetcher

neurostats_API-0.0.4/neurostats_API/utils/data_process.py

@@ -0,0 +1,18 @@
+from importlib.resources import files
+import json
+import yaml
+
+class StatsProcessor:
+    @classmethod
+    def load_txt(cls, filename, json_load = True):
+        txt_path = files('neurostats_API.tools').joinpath(filename)
+        with open(txt_path, 'r', encoding='utf-8') as f:
+            data = json.load(f) if (json_load) else f.read() 
+        return data
+    @classmethod
+    def load_yaml(cls, filename):
+        yaml_path = files('neurostats_API.tools').joinpath(filename)
+        with open(yaml_path, 'r', encoding='utf-8') as f:
+            data = yaml.safe_load(f)
+
+        return data

{neurostats_API-0.0.3 → neurostats_API-0.0.4}/neurostats_API/utils/fetcher.py

@@ -1,8 +1,9 @@
-from .utils.db_client import shared_client
+from .db_client import shared_client
 import pandas as pd
 import json
 import pytz
 from datetime import datetime, timedelta, date
+from .data_process import StatsProcessor
 import yaml
 
 
@@ -14,10 +15,7 @@ class StatsFetcher:
 
         self.timezone = pytz.timezone("Asia/Taipei")
 
-        self.inverse_dict = dict()
-
-        with open("./tools/seasonal_data_field_dict.txt") as f:
-            self.inverse_dict = json.load(f)
+        self.inverse_dict = StatsProcessor.load_txt("seasonal_data_field_dict.txt", json_load=True)
 
         self.seasons = ["01", "02", "03", "04"]
 
@@ -326,28 +324,6 @@ class StatsFetcher:
                 "seasonal_data.season": 1
             }})
 
-        # self.pipeline.append({
-        #     "$group": {
-        #         "_id": {
-        #             "ticker": "$ticker",
-        #             "company_name": "$company_name"
-        #         },
-        #         "seasonal_data": {
-        #             "$push": "$seasonal_data.balance_sheet"
-        #         }
-        #     }
-        # })
-
-        # self.pipeline.append({
-        #     "$project": {
-        #         "ticker": "$_id.ticker",
-        #         "company_name": "$_id.company_name",
-        #         "seasonal_data": {
-        #             "balance_sheet": "$seasonal_data"
-        #         }
-        #     }
-        # })
-
         fetched_datas = list(self.collection.aggregate(self.pipeline))
 
         return fetched_datas
@@ -640,12 +616,14 @@ class StatsFetcher:
         """
         today_dict = self._get_today()
 
-        today = today_dict['today'].strftime("%Y-%m-%d")
+        today = today_dict['today']
+        target_season = ((today.month - 1) // 3) + 1
 
         start_date = "2014-01-01"
+        end_date = today.strftime("%Y-%m-%d")
 
-        query_data = self.query_seasonal_data(ticker, start_date, today,
-                                              "balance_sheet")
+        query_data = self.query_seasonal_data(ticker, start_date, end_date,
+                                              "balance_sheet", target_season=target_season)
 
         return_dict = {
             "ticker": query_data[0]['ticker'],
@@ -894,8 +872,7 @@ class StatsFetcher:
         """
         today_dict = self._get_today()
 
-        with open(f"./tools/profit_lose.yaml", 'r') as f:
-            table_settings = yaml.safe_load(f)
+        table_settings = StatsProcessor.load_yaml("profit_lose.yaml")
         today = today_dict['today'].strftime("%Y-%m-%d")
         start_date = "2014-01-01"
 
@@ -972,13 +949,16 @@ class StatsFetcher:
         """
         today_dict = self._get_today()
 
-        today = today_dict['today'].strftime("%Y-%m-%d")
+        today = today_dict['today']
+        this_season = (today.month - 1) // 3 + 1
         start_date = "2014-01-01"
+        end_date = today.strftime("%Y-%m-%d")
 
         query_data = self.query_seasonal_data(ticker,
                                               start_date=start_date,
-                                              end_date=today,
-                                              sheet='cash_flow')
+                                              end_date=end_date,
+                                              sheet='cash_flow',
+                                              target_season=this_season)
 
         index_names = []
 
@@ -1074,64 +1054,4 @@ class StatsFetcher:
         return_dict['CASHI'] = CASHI_table
         return_dict['CASHF'] = CASHF_table
 
-        return return_dict
-
-    def get_financial_sheet(self, ticker):
-        """
-        (尚未完成)
-        iFa.ai: 財務分析 -> 重要指標
-        """
-        # Not implemented !!!!
-        return
-        today = datetime.today()
-        this_year = today.year
-        start_date = (f"{this_year}-01-01")
-        today = today.strftime("%Y-%m-%d")
-
-        this_year_data = self.query_seasonal_data(ticker, start_date, today)
-
-        latest_seasonal_data = this_year_data["seasonal_data"][-1]
-        all_time_data = this_year_data['seasonal_data']
-
-        # retrieved_list = [
-        #     "營業收入合計",
-        #     "營業毛利（毛損）淨額",
-        #     "營業利益（損失）",
-        #     "本期淨利（淨損）",
-        #     "營業活動之淨現金流入（流出）",
-        #     "投資活動之淨現金流入（流出）",
-        #     "籌資活動之淨現金流入（流出）",
-        # ]
-
-        try:
-            single_month_revenue_dict = {
-                "revenue": {
-                    "value":
-                    latest_seasonal_data['profit_lose']["營業收入合計"],
-                    "accumulation":
-                    self._accumulate(all_time_data, 'profit_lose', "營業收入合計"),
-                    "name":
-                    '營業收入'
-                }
-            }
-        except:
-            try:
-                single_month_revenue_dict = {
-                    "revenue": {
-                        "value":
-                        latest_seasonal_data['profit_lose']["利息收入"],
-                        "accumulation":
-                        self._accumulate(all_time_data, 'profit_lose', "利息收入"),
-                        "name":
-                        '利息收入'
-                    }
-                }
-            except:
-                single_month_revenue_dict = {
-                    "revenue": {
-                        "value": None,
-                        "accumulation": None,
-                        "name": "營業收入"
-                    }
-                }
-        return_dict.update()
+        return return_dict

{neurostats_API-0.0.3 → neurostats_API-0.0.4}/neurostats_API.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neurostats-API
-Version: 0.0.3
+Version: 0.0.4
 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-0.0.4}/neurostats_API.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+MANIFEST.in
 README.md
 setup.py
 neurostats_API/__init__.py
@@ -15,7 +16,11 @@ neurostats_API/fetchers/month_revenue.py
 neurostats_API/fetchers/profit_lose.py
 neurostats_API/fetchers/tech.py
 neurostats_API/fetchers/value_invest.py
+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/data_process.py
 neurostats_API/utils/datetime.py
 neurostats_API/utils/db_client.py
 neurostats_API/utils/fetcher.py

{neurostats_API-0.0.3 → neurostats_API-0.0.4}/setup.py

@@ -2,15 +2,16 @@ from setuptools import setup, find_packages
 
 setup(
     name='neurostats_API',
-    version='0.0.3',
+    version='0.0.4',
     long_description=open('README.md', 'r', encoding='utf-8').read(),
     long_description_content_type='text/markdown',
     install_requires=[
     ],
     author='JasonWang@Neurowatt',
     packages=find_packages(exclude=['.venv', 'test*', 'data_in_db', '.pytest_cache']),
-    package_dir={'neurostats_service': 'src'},
-    package_data={'neurostats_service': ['tools/*.yaml']},
+    include_package_data=True,
+    # package_dir={'neurostats_service': 'src'},
+    package_data={'neurostats_API': ['tools/*.yaml', 'tools/*.txt']},
     author_email='jason@neurowatt.ai',
     description='The service of NeuroStats website',
     url='https://github.com/NeurowattStats/NeuroStats_API.git',

{neurostats_API-0.0.3 → neurostats_API-0.0.4}/test/test_fetchers.py

@@ -1,10 +1,11 @@
 import pytest
 import pandas as pd
 import yaml
+from neurostats_API.utils import StatsProcessor
 
 
 def test_value():
-    from fetchers.value_invest import ValueFetcher
+    from neurostats_API.fetchers import ValueFetcher
     fetcher = ValueFetcher(ticker='2330')
 
     fetched_data = fetcher.query_data()
@@ -16,21 +17,46 @@ def test_value():
     assert isinstance(fetched_data['yearly_data'], pd.DataFrame)
 
 def test_profit_lose():
-    from utils.fetcher import StatsFetcher
+    from neurostats_API.utils import StatsFetcher
 
     fetcher = StatsFetcher()
 
     data = fetcher.get_profit_lose("2330")
 
-    with open(f"./tools/profit_lose.yaml", 'r') as f:
-        table_settings = yaml.safe_load(f)
+    table_settings = StatsProcessor.load_yaml("profit_lose.yaml")
     
     for key in table_settings.keys():
         assert key in data.keys()
 
+def test_cash_flow():
+    from neurostats_API.utils import StatsFetcher
+
+    fetcher = StatsFetcher()
+    data = fetcher.get_cash_flow("2330")
+
+    assert("cash_flow" in data.keys())
+
+def test_month_revenue():
+    from neurostats_API.utils import StatsFetcher
+
+    fetcher = StatsFetcher()
+    data = fetcher.get_month_revenue_sheet("2330")
+
+    assert("month_revenue" in data.keys())
+
+def test_balance_sheet():
+    from neurostats_API.utils import StatsFetcher
+
+    fetcher = StatsFetcher()
+
+    data = fetcher.get_balance_sheet("2330")
+
+    table_settings = StatsProcessor.load_yaml("profit_lose.yaml")
+    
+    "balance_sheet" in data.keys()
 
 def test_finance_overview():
-    from fetchers import FinanceOverviewFetcher
+    from neurostats_API.fetchers import FinanceOverviewFetcher
     fetcher = FinanceOverviewFetcher(ticker='2330')
     fetched_data = fetcher.query_data()
 

neurostats_API-0.0.3/neurostats_API/__init__.py

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

neurostats_API-0.0.3/neurostats_API/fetchers/__init__.py

@@ -1 +0,0 @@
-from .finance_overview import FinanceOverviewFetcher

neurostats_API-0.0.3/neurostats_API/utils/__init__.py

@@ -1,2 +0,0 @@
-from .fetcher import StatsFetcher
-from .datetime import StatsDateTime