Skip to content

Commit 067d83f

Browse files
committed
release 1.0.0
1 parent 8e04808 commit 067d83f

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ w.visualize()
112112
AutoQuant support Shanghai, Shenzhen, HongKong and US markets now.
113113
Use Market Enum in codes:
114114

115-
```
115+
```python
116116
from autoquant import Market
117117

118118
Market.SZ
@@ -126,7 +126,7 @@ Market.US
126126
AutoQuant support the indexes in multiple markets now.
127127

128128
Use StocksIndex Enum in codes:
129-
```
129+
```python
130130
from autoquant import StocksIndex
131131

132132
StocksIndex.ZZ500
@@ -136,7 +136,7 @@ StocksIndex.SZ50
136136

137137
Use FundsIndex Enum in codes:
138138

139-
```
139+
```python
140140
from autoquant import FundsIndex
141141

142142
FundsIndex.CN_ALL
@@ -155,15 +155,17 @@ FundsIndex.CN_ETF
155155
All the metrics in TA-Lib are available in AutoQuant.
156156

157157
For Example, if you were using the metrics of TA-Lib like this:
158-
```
158+
159+
```python
159160
from talib import SMA
160161

161162
close = numpy.random.random(100)
162163
output = MOM(close, timeperiod=5)
163164
```
164165

165166
You can simply change the import sentence to use the metrics in AutoQuant. The codes would be:
166-
```
167+
168+
```python
167169
from AutoQuant import SMA
168170

169171
close = numpy.random.random(100)
@@ -181,7 +183,7 @@ output = MOM(close, timeperiod=5)
181183
- EastmoneyProvider
182184

183185
#### API
184-
```
186+
```python
185187
def daily_prices(self, market: Market, code: str, start: date, end: date, **kwargs)
186188

187189
```
@@ -196,7 +198,7 @@ def daily_prices(self, market: Market, code: str, start: date, end: date, **kwar
196198

197199
#### API
198200

199-
```
201+
```python
200202
def quarter_statement(self, market: Market, code: str, quarter: date, **kwargs)
201203

202204
def yearly_balance_sheet(self, market: Market, code: str, years: list, **kwargs)
@@ -215,7 +217,7 @@ def yearly_income_sheets(self, market: Market, code: str, years: list, **kwargs)
215217

216218
#### API
217219

218-
```
220+
```python
219221
def stocks_of_index(self, index: StocksIndex, **kwargs)
220222

221223
def funds_of_index(self, index: FundsIndex, **kwargs)
@@ -225,12 +227,12 @@ def funds_of_index(self, index: FundsIndex, **kwargs)
225227

226228
## Test
227229
### Test all
228-
```
230+
```shell
229231
PYTHONPATH=./ pytest
230232
```
231233

232234
### Test specified test
233-
```
235+
```shell
234236
PYTHONPATH=./ pytest tests/<YOUR_DISIRE_FILE>.py -k "<YOUR_DISIRE_TEST_CASE>" -s
235237
```
236238

@@ -239,12 +241,12 @@ PYTHONPATH=./ pytest tests/<YOUR_DISIRE_FILE>.py -k "<YOUR_DISIRE_TEST_CASE>" -s
239241

240242
### Generate Requirements
241243

242-
```
244+
```shell
243245
pipreqs ./ --encoding=utf8 --force
244246
```
245247
### Package Update
246248

247-
```
249+
```shell
248250
python3 -m build
249251
python3 -m twine upload dist/*
250252
```

0 commit comments

Comments
 (0)