siat 1.3.0.6__tar.gz → 3.9.1__tar.gz

siat-3.9.1/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 WANG Dehong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software (siat) and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

siat-3.9.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include siat/stock_info.pickle
+include siat/exchange_bond_china.pickle
+include siat/fund_china.pickle

siat-3.9.1/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.2
+Name: siat
+Version: 3.9.1
+Summary: Securities Investment Analysis Tools (siat)
+Home-page: https://pypi.org/project/siat/
+Author: Prof. WANG Dehong, International Business School, Beijing Foreign Studies University
+Author-email: wdehong2000@163.com
+License: Copyright (C) WANG Dehong, 2024. For educational purpose only!
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas_datareader
+Requires-Dist: yfinance
+Requires-Dist: tqdm
+Requires-Dist: plotly_express
+Requires-Dist: akshare
+Requires-Dist: urllib3
+Requires-Dist: mplfinance
+Requires-Dist: statsmodels
+Requires-Dist: yahoo_earnings_calendar
+Requires-Dist: pypinyin
+Requires-Dist: seaborn
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: pandas
+Requires-Dist: scikit-learn
+Requires-Dist: baostock
+Requires-Dist: pyproject.toml
+Requires-Dist: pathlib
+Requires-Dist: ruamel-yaml
+Requires-Dist: prettytable
+Requires-Dist: graphviz
+Requires-Dist: luddite
+Requires-Dist: pendulum
+Requires-Dist: itables
+Requires-Dist: py_trans
+Requires-Dist: bottleneck
+Requires-Dist: translate
+Requires-Dist: translators
+Requires-Dist: nbconvert
+Requires-Dist: ipywidgets==8.1.6
+Requires-Dist: playwright
+Requires-Dist: yahooquery==2.3.7
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+
+# What is siat?
+siat is a Python 3 plug-in for security investment analysis, primarily designed for teaching and learning purposes in universities for undergraduate and postgraduate programs.
+
+siat is recommended to run in Jupyter Notebook or Jupyter Lab, and most of its results are in the forms of figures and/or tables.
+# Version naming
+Version structure: X.Y.Z
+
+X is the major version for architecture upgrade only.
+Y is the functional version for functional enhancements.
+Z is the minor version just for bug fixing.
+
+# Quick examples of using siat
+
+
+```python
+# Enable siat
+from siat import *
+```
+
+
+```python
+# Set language to English, default is Chinese
+set_language("English")
+```
+
+## Example 1: Apple stock price for the recent month
+
+
+```python
+# Simple way: show Apple's stock price in recent month
+apple=security_trend("AAPL")
+```
+You may expect more information, such as price trend in a recent year (MRY), with the high/low point, current price and average price, like below:
+
+```python
+apple=security_trend("AAPL", start="MRY",
+                     mark_top=True, mark_bottom=True, mark_end=True,
+                     average_value=True)
+```
+
+## Example 2: Comparing Price changes among Apple, Microsoft and NVidia 
+You may expect compare the price changes for the recent quarter (MRQ) for the three stocks.
+
+Since there is a major stock split for NVidia in 2024 by 1:10, it is necessary to use adjusted prices (Adj Close) to compare these stock prices.
+
+```python
+comp=security_trend(['AAPL','MSFT','NVDA'], 
+                    start='MRQ', 
+                    indicator='Adj Close', 
+                    preprocess='scaling', #use scaling drawing method to avoid loss of details
+                    mark_top=True, mark_bottom=True, 
+                    annotate=True, annotate_value=True)
+```
+
+## Example 4: Bollinger band for Apple in the recent quarter
+
+
+```python
+# security_technical only supports 4 popular technical indicators: MACD, Bollinger, KDJ and RSI. 
+apple=security_technical("AAPL",
+                         technical="Bollinger",
+                         start="MRQ",
+                         facecolor="white",
+                         loc1="upper left", loc2="lower right")
+```
+
+## Example 5: CCI for Apple in recent quarter
+
+
+```python
+# security_technical2 supports up to 14 popular technical indicators.
+# security_technical2 uses a simplied drawing method (Dehong graph) to avoid trypophobia [藢tr瑟p蓹u'f蓹蕣bj蓹]
+apple=security_technical2("AAPL",
+                         technical="CCI",
+                         start="MRM",
+                         loc1="upper left", loc2="lower right")
+```
+
+# What security products does siat support?
+1. Public company profile:  world-wide
+2. Stock & stock market index: world-wide
+3. Stock valuation: primarily in China (mainland and HK) and the U.S.
+4. Stock option chain: primarily in the U.S.
+5. Bond: primarily in China and the U.S.
+6. Markowitz portfolio: with all the supported stocks and bonds
+7. Fund: primarily in China and the U.S.
+8. Futures: primarily in China and the U.S.
+9. Options: primarily in China and the U.S.
+10. Digital currency:  world-wide (some may be restricted by data sources)
+11. Balance sheet: in China (full function) and world-wide (basic function)
+12. Income statement: in China mainland (full function) and world-wide (basic function)
+13. Cash flow statement: in China mainland (full function) and world-wide (basic function)
+14. DuPont Identity: world-wide
+15. Sector trend and valuation: primarily in China
+# What analytical methods does siat support?
+1. Trend analysis
+2. Panel comparation
+3. Return analysis: rolling returns, holding period returns
+4. Risk analysis: rolling volatility, holding period volatility, LPSD
+5. Technical analysis: more than 15 indicators
+6. Risk-adjusted return: Sharpe ratio, Sortino ratio, Treynor ratio, Jensen alpha
+7. Portfolio optimization: four risk-adjusted returns
+8. CAPM beta trend
+9. Beta adjustments: simple adjustment, Scholes-Williams, Dimson
+10. Beta leverage: Hamada Model
+11. Fama-French three-factor model
+12. Fama-French-Carhart four-factor model
+13. Fama-French five-factor model
+14. Future pricing
+15. Option pricing: European style, American style, with/without dividends
+16. VaR & ES: variance-covariance, historic simulation, Monte Carlo, multiple periods
+17. Liquidity risk: Roll spread, Amihud, Pastor-Stambaugh
+18. ESG: basic functions
+# Do I have to download data first before using siat?
+NO!
+siat will search the internet data sources for all the required data during analysis.
+The main data sources siat uses:
+1. Yahoo Finance
+2. Sina Finance
+3. East Money
+4. Stooq (Polish)
+5. FRED
+6. OECD
+7. IMF
+8. Shanghai Stock Exchange
+9. Shenzhen Stock Exchange
+10. Hong Kong Stock Exchange
+11. Beijing Stock Exchange
+12. Tokyo Stock Exchange
+13. London Stock Exchange
+14. New York Stock Exchange
+15. NASDAQ
+16. Sustainalytics
+
+Thanks the above websites for their valuable data!
+# How to install siat?
+The author strongly recommends using siat together with Jupyter Notebook or Jupyter Lab in Anaconda.
+In order to install siat for the very first time, open a Jupyter Notebook, and type in the following command:
+
+!pip install siat
+
+If the above method does not work, something might be wrong in your Python path settings. Try to open an Anaconda Prompt in Windows or a Terminal App in Mac or Linux, and type in the following command:
+
+pip install siat
+# How to upgrade siat?
+In Jupyter Notebook or Jupyter Lab:
+
+upgrade_siat()
+
+If you suffer from slow internet connection (often in campus classrooms with many students), try to use alternative sources, such as:
+
+upgrade_siat(alternative="tsinghua")
+
+upgrade_siat(alternative="alibaba")
+
+If the above methods do not work for your environment, you have to goto the traditional ways to use command-line script, such as:
+
+pip install --upgrade siat
+
+*** For users in China
+The pypi mirror websites may provide siat installing and upgrading in a much faster speed in the following commands: taking aliyun as an example
+
+pip install siat -i https://mirrors.aliyun.com/pypi/simple/
+
+pip install --upgrade siat https://mirrors.aliyun.com/pypi/simple/
+
+*** Warning
+1. The pip command itself may need upgrade as well.
+2. The pip command sometimes may have conflicts with some vpn programs.
+If in this case, try quit vpn program first, and try again. 
+# Are there more detailed case studies on using siat?
+YES!
+
+There are hundreds of video case studies in the author's channel (most in Chinese, some in English).
+
+https://space.bilibili.com/284812153
+
+Welcome to follow the channel!
+# How to report a bug or look for help?
+Write to the author, Prof. WANG Dehong, wdehong2000@163.com

siat-3.9.1/setup.py

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+"""
+@author: WANG Dehong (Peter), IBS BFSU
+"""
+
+from setuptools import setup, find_packages
+from pathlib import Path
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+#description does not support image, text only
+
+setup(
+    name="siat",
+    version="3.9.1",
+    #author="Prof. WANG Dehong, Business School, BFSU (北京外国语大学 国际商学院 王德宏)",
+    author="Prof. WANG Dehong, International Business School, Beijing Foreign Studies University",
+    author_email="wdehong2000@163.com",
+    description="Securities Investment Analysis Tools (siat)",
+    url = "https://pypi.org/project/siat/",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    license="Copyright (C) WANG Dehong, 2024. For educational purpose only!",
+    packages = find_packages(),
+    install_requires=[
+        'pandas_datareader',
+        'yfinance',
+        #'pandas_alive',
+        'tqdm',
+        'plotly_express',
+        #'akshare==1.3.95',#为与urllib3兼容
+        #'akshare==1.4.57',#为其他兼容考虑
+        #'akshare==1.10.3',
+        'akshare',
+        #'urllib3==1.25.11',#为其他兼容考虑
+        'urllib3',
+        #'urllib3',
+        'mplfinance',
+        'statsmodels',
+        'yahoo_earnings_calendar',
+        'pypinyin',
+        'seaborn',
+        'numpy',
+        'scipy',
+        #'pandas==1.5.3',#为其他兼容考虑
+        'pandas',
+        'scikit-learn',
+        'baostock',
+        'pyproject.toml',
+        #'ta-lib',#ta-lib需要单独安装，并与Python版本配套
+        'pathlib','ruamel-yaml','prettytable',
+        'graphviz',#graphviz可能还需要额外安装程序
+        'luddite',
+        'pendulum','itables','py_trans','bottleneck',
+        'translate','translators',
+        #注意：translators 5.9.5要求lxml >=5.3.0，与yahooquery的要求矛盾
+        'nbconvert',
+        'ipywidgets==8.1.6',#解决Error loading widgets
+        'playwright',#安装后还需要执行指令：playwright install
+        #'yahooquery==2.2.14',#为其他兼容考虑
+        'yahooquery==2.3.7',#解决数据获取失败crump限制
+        #注意：临时措施，yahooquery 2.3.7要求lxml 4.9.4
+
+    ],            
+    #zip_sage=False,
+    include_package_data=True, # 打包包含静态文件标识
+) 

siat-3.9.1/siat/__init__.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+"""
+功能：一次性引入SIAT的所有模块
+作者：王德宏，北京外国语大学国际商学院
+版权：2021-2025(C) 仅限教学使用，商业使用需要授权
+联络：wdehong2000@163.com
+"""
+
+#==============================================================================
+#屏蔽所有警告性信息
+import warnings; warnings.filterwarnings('ignore')
+#==============================================================================
+from siat.allin import *
+
+import pkg_resources
+current_version=pkg_resources.get_distribution("siat").version
+#current_list=current_version.split('.')
+
+#==============================================================================
+# 处理stooq.py修复问题
+restart=False
+tagfile='fix_package.pkl'
+
+#判断操作系统
+import sys; czxt=sys.platform
+if czxt in ['win32','win64']:
+    os='windows'
+elif czxt in ['darwin']: #MacOSX
+    os='mac'
+elif czxt in ['linux']: #linux
+    os='linux'
+else:
+    os='windows'
+
+# 确定标记文件存放地址
+import pandas
+srcpath=pandas.__path__[0]
+if os == 'windows':
+    srcpath1=srcpath.replace("\\",'/')
+    srcfile=srcpath1+'/'+tagfile
+else:
+    srcpath1=srcpath
+    srcfile=srcpath1+'/'+file
+
+try:
+    with open(srcfile,'rb') as file:
+        siat_ver=pickle.load(file)
+        if siat_ver != current_version:
+            restart=True
+            with open(srcfile,'wb') as file:
+                pickle.dump(current_version,file)
+except:
+    restart=True
+    with open(srcfile,'wb') as file:
+        pickle.dump(current_version,file)
+
+#屏蔽函数内print信息输出的类
+import os, sys
+class HiddenPrints:
+    def __enter__(self):
+        self._original_stdout = sys.stdout
+        sys.stdout = open(os.devnull, 'w')
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        sys.stdout.close()
+        sys.stdout = self._original_stdout
+
+if not restart:
+    print("  Successfully enabled siat v{}".format(current_version))
+else:
+    with HiddenPrints():
+        fix_package()
+    print("  Please RESTART Python kernel and run this command again")
+
+#==============================================================================

siat-3.9.1/siat/allin.py

@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+"""
+功能：一次性引入SIAT的所有模块
+作者：王德宏，北京外国语大学国际商学院
+版权：2022(C) 仅限教学使用，商业使用需要授权
+联络：wdehong2000@163.com
+"""
+
+# 资产流动性
+from siat.assets_liquidity import *
+
+# 贝塔系数调整方法
+from siat.beta_adjustment import *
+from siat.beta_adjustment_china import *
+
+# 债券
+from siat.bond import *
+
+# 资本资产定价模型
+from siat.capm_beta import *
+from siat.capm_beta2 import *
+
+# 数字货币
+from siat.cryptocurrency import *
+
+# 宏观经济
+from siat.economy import *
+from siat.economy2 import *
+
+
+# ESG
+from siat.esg import *
+
+# 资产定价-多因子模型
+from siat.fama_french import *
+
+# 财务报表：雅虎源
+from siat.financial_statements import *
+
+# 财务分析：雅虎源
+from siat.financials import *
+
+# 财务分析：雅虎源
+from siat.financials2 import *
+
+# 财务报表：雅虎源
+from siat.fin_stmt2_yahoo import *
+
+# 财务分析：中国
+from siat.financials_china import *
+
+# 财务分析：中国，资产负债结构分析
+from siat.financials_china2 import *
+
+# 中国的基金
+from siat.fund_china import *
+
+# 中国的期货（内盘与部分外盘）
+from siat.future_china import *
+
+# 中国的期权
+from siat.option_china import *
+
+# 资产的持有风险
+from siat.holding_risk import *
+
+# 投资组合理论
+#from siat.markowitz import *
+from siat.markowitz2 import *
+
+# 投资组合理论自助式示意图
+#from siat.markowitz_simple import *
+
+# 期权定价
+from siat.option_pricing import *
+
+# 风险调整收益
+from siat.risk_adjusted_return import *
+from siat.risk_adjusted_return2 import *
+
+# 风险评估
+from siat.risk_evaluation import *
+
+# 中国的行业分析
+from siat.sector_china import *
+
+# 股票/行业指数估值：美股，港股，A股，波兰股，指数
+from siat.valuation import *
+
+# 中国股票/市场估值
+from siat.valuation_china import *
+
+# 获取证券价格与计算
+from siat.security_prices import *
+from siat.security_price2 import *
+from siat.other_indexes import *
+
+# 股票分析
+from siat.stock import *
+
+# 股票趋势分析，集成函数
+from siat.security_trend2 import *
+
+# 中国的股票
+from siat.stock_china import *
+
+# 中国股票市场概况
+from siat.market_china import *
+
+# 证券交易-套壳
+from siat.transaction import *
+
+# 持有资产风险-模型验证
+from siat.var_model_validation import *
+
+# 跨种类比较分析
+from siat.compare_cross import *
+
+# 机器学习-课程案例
+#from siat.ml_cases import *
+#from siat.stock_advice_linear import *
+
+# 股票技术分析
+from siat.stock_technical import *
+
+# 事件研究法
+from siat.event_study import *
+
+# 2FA: Google Authenticator
+from siat.google_authenticator import *
+
+# 提问记录
+from siat.luchy_draw import *
+
+# 搜索全球上市公司的英文名称，需要访问雅虎
+from siat.yf_name import *
+