Metadata-Version: 2.1
Name: wxve
Version: 0.0.11
Summary: A stock analysis package in Python that equips objects with the information required to streamline operations.
Home-page: https://github.com/AG3NTZ3R0/wxve
Author: Brandon J. Lacy
Author-email: Z3R0@duck.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/AG3NTZ3R0/wxve/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# wxve

A stock analysis package in Python that equips objects with the information required to streamline operations.

## Install
```shell
pip install wxve
```

## Subscribe to API
Stock data is provided by the YH Finance API.
Create an account on RapidAPI and subscribe to the right plan for you. The **free** plan provides 500 requests per month with a rate limit of 5 requests per second. <br>
https://rapidapi.com/apidojo/api/yh-finance/

## Tutorial
```python
import wxve as x

IBM = x.Stock('IBM', 'YOUR_API_KEY')

IBM.candlestick.show()

print(IBM.div_df)
print(IBM.hist_df)
```
```python
import wxve as x

stock_list = ['IBM', 'INTC', 'NVDA']
ai_chip_makers = x.StockSet(stock_list, 'YOUR_API_KEY') 

ai_chip_makers.stocks['IBM'].candlestick.show()

print(ai_chip_makers.stocks['IBM'].div_df)
print(ai_chip_makers.stocks['IBM'].hist_df)
```

