siat 3.2.19__py3-none-any.whl → 3.2.20__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: siat
3
- Version: 3.2.19
3
+ Version: 3.2.20
4
4
  Summary: Securities Investment Analysis Tools (siat)
5
5
  Home-page: https://pypi.org/project/siat/
6
6
  Author: Prof. WANG Dehong, International Business School, Beijing Foreign Studies University
@@ -32,17 +32,22 @@ Requires-Dist: graphviz
32
32
  Requires-Dist: luddite
33
33
  Requires-Dist: pendulum
34
34
 
35
- <center><font size=6 color='blue'>Welcome to the Magic World of <font color='red'> siat
35
+ # Welcome to the Magic World of siat
36
36
 
37
37
  # Version history
38
38
  Current version: 3.2
39
+
39
40
  This version unifies the architecture of stock, bond and investment fund together.
40
- The unifcation not only makes it convenient to analyze stock, bond and investment fund in same scripts, but also make it easier to construct an investment portfolio with stock, bond and investment fund as components.Version structure: X.Y.Z
41
+
42
+ The unifcation not only makes it convenient to analyze stock, bond and investment fund in same scripts, but also make it easier to construct an investment portfolio with stock, bond and investment fund as components.
43
+ Version structure: X.Y.Z
44
+
41
45
  X is the major version for architecture upgrade only.
42
46
  Y is the functional version for functional enhancement.
43
47
  Z is the minor version just for bug fixing.
44
48
  # What is siat?
45
49
  siat is a Python plug-in, which stands for security investment analysis toolkit.
50
+
46
51
  It is specially designed for teaching and learning purposes on security investment in universities for undergraduate and postgraduate programs.
47
52
  # Quick examples of using siat
48
53
 
@@ -51,24 +56,12 @@ It is specially designed for teaching and learning purposes on security investme
51
56
  from siat import *
52
57
  ```
53
58
 
54
- Successfully imported siat version 3.2.18
55
-
56
-
57
59
  ## Example 1: Apple stock price for the recent month
58
60
 
59
61
 
60
62
  ```python
61
63
  apple=security_trend("AAPL")
62
64
  ```
63
-
64
- Successfully retrieved 774 records for AAPL Apple
65
-
66
-
67
-
68
-
69
- ![png](output_9_1.png)
70
-
71
-
72
65
  You may expect to more information, such as price trend in a recent year (MRY), with the high/low point, current price and average price, like below:
73
66
 
74
67
  ```python
@@ -77,17 +70,9 @@ apple=security_trend("AAPL", start="MRY",
77
70
  average_value=True)
78
71
  ```
79
72
 
80
- Successfully retrieved 1023 records for AAPL Apple
81
-
82
-
83
-
84
-
85
- ![png](output_11_1.png)
86
-
87
-
88
-
89
73
  ## Example 2: Comparing Price changes among Apple, Microsoft and NVidia
90
74
  You may expect compare the price changes for the recent quarter (MRQ) for the three stocks.
75
+
91
76
  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.
92
77
 
93
78
  ```python
@@ -99,61 +84,30 @@ comp=security_trend(['AAPL','MSFT','NVDA'],
99
84
  annotate=True, annotate_value=True)
100
85
  ```
101
86
 
102
- Searching for multiple security information for Adj Close, it may take great time ...
103
- Looking security info for MSFT ...
104
- Looking security info for AAPL ...
105
- Looking security info for NVDA ...
106
-
107
-
108
-
109
-
110
- ![png](output_14_1.png)
111
-
112
-
113
-
114
87
  ## Example 4: Bollinger band for Apple in the recent quarter
115
88
 
116
89
 
117
90
  ```python
118
- # Script security_technical only supports 4 popular technical indicators:
119
- # MACD, Bollinger band, KDJ and RSI.
91
+ # Script security_technical only supports 4 popular technical indicators: MACD, Bollinger band, KDJ and RSI.
92
+
120
93
  apple=security_technical("AAPL",
121
94
  technical="Bollinger",
122
95
  start="MRQ",
123
96
  loc1="upper left", loc2="lower right")
124
97
  ```
125
98
 
126
- Successfully retrieved 313 records for AAPL Apple
127
- Smoothening curves ...
128
-
129
-
130
-
131
-
132
- ![png](output_16_1.png)
133
-
134
-
135
-
136
99
  ## Example 5: CCI for Apple in recent quarter
137
100
 
138
101
 
139
102
  ```python
140
- # Script security_technical2 supports about 20 popular technical indicators in Dehong-style graph:
103
+ # Script security_technical2 supports about 20 popular technical methods.
104
+
141
105
  apple=security_technical2("AAPL",
142
106
  technical="CCI",
143
107
  start="MRM",
144
108
  loc1="upper left", loc2="lower right")
145
109
  ```
146
110
 
147
- Successfully retrieved 185 records for AAPL Apple
148
-
149
-
150
-
151
-
152
-
153
- ![png](output_18_1.png)
154
-
155
-
156
-
157
111
  # What sorts of security product does siat support?
158
112
  1. Public company profile: world-wide
159
113
  2. Stock & stock market index: world-wide
@@ -210,24 +164,33 @@ Thanks the above websites for their valuable data supply!
210
164
  # How to install siat?
211
165
  The author strongly recommends using siat together with Jupyter Notebook or Jupyter Lab in Anaconda.
212
166
  In order to install siat for the very first time, open a Jupyter Notebook, and type in the following command:
167
+
213
168
  !pip install siat
214
169
 
215
170
  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:
171
+
216
172
  pip install siat
217
173
  # How to upgrade siat?
218
174
  In Jupyter Notebook or Jupyter Lab:
175
+
219
176
  upgrade_siat()
220
177
 
221
178
  If you suffer from slow internet connection (often in campus classrooms with many students), try to use alternative sources, such as:
179
+
222
180
  upgrade_siat(alternative="tsinghua")
181
+
223
182
  upgrade_siat(alternative="alibaba")
224
183
 
225
184
  If the above methods do not work for you, you have to goto the traditional ways to use command-line script, such as:
185
+
226
186
  pip install --upgrade siat
227
187
  # Are there more detailed case studies on using siat?
228
188
  YES!
189
+
229
190
  There are hundreds of video case studies in the author's channel (most in Chinese, some in English).
191
+
230
192
  https://space.bilibili.com/284812153
193
+
231
194
  Welcome to follow the channel!
232
195
  # How to report a bug or look for help?
233
196
  Write to the author, Prof. WANG Dehong, wdehong2000@163.com
@@ -136,7 +136,7 @@ siat/valuation.py,sha256=NKfeZMdDJOW42oLVHob6eSVBXUqlN1OCnnzwyGAst8c,48855
136
136
  siat/valuation_china.py,sha256=EkZQaVkoBjM0c4MCNbaX-bMnlG0e3FXeaWczZDnkptU,67784
137
137
  siat/valuation_market_china_test.py,sha256=gbJ0ioauuo4koTPH6WKUkqcXiQPafnbhU5eKJ6lpdLA,1571
138
138
  siat/var_model_validation.py,sha256=R0caWnuZarrRg9939hxh3vJIIpIyPfvelYmzFNZtPbo,14910
139
- siat-3.2.19.dist-info/METADATA,sha256=Evo5NVjOLinr5OZqEHt0G7yYTFbYmQN-1mQdBOoGI3Q,8074
140
- siat-3.2.19.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
141
- siat-3.2.19.dist-info/top_level.txt,sha256=r1cVyL7AIKqeAmEJjNR8FMT20OmEzufDstC2gv3NvEY,5
142
- siat-3.2.19.dist-info/RECORD,,
139
+ siat-3.2.20.dist-info/METADATA,sha256=nbos2VGpGWtUaE6WZqD8wxPZ44yonDhP7a78SBvesxg,7234
140
+ siat-3.2.20.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
141
+ siat-3.2.20.dist-info/top_level.txt,sha256=r1cVyL7AIKqeAmEJjNR8FMT20OmEzufDstC2gv3NvEY,5
142
+ siat-3.2.20.dist-info/RECORD,,
File without changes