Skip to main content

This package provides user-friendly functions to easily navigate stock information of the companies of their interests. The output results include visualization of closing prices and daily returns, stock prediction for the next twenty days, as well as the company information with sectors and PE ratios.

Project description

Stock_Info_Easy

This Python package is an implementation of the existing yfinance wrapper, one of the widely used yahoo finance API wrappers.

Most of the times, the currently available finance API wrappers take company symbols as queries instead of company names. This often causes confusion as it is difficult to guess company symbols (eg. what is the abbreviation of the company Apple - APPL? AAPL? or APLE?)

Therefore, this package hopes to provide an improved functionality of querying by enabling users to fetch stock data by company name(s) alone.
The fetched data includes:

  • company name, open, high, low, close (closing price), adj close, volume, daily return, and PE ratios.

The stock information will be provided in dynamic formats with the use of visualizations, a data table, a stock forecast and an audio file.

Installation

$ pip install stock_info_easy

Usage

# Insert the name(s) of company(ies) inside the `get_hist_data` function.  ex) ['amazon', 'apple', 'google', 'microsoft']
>>> data_list, comp_names_abbr, company_list, comp_names = stock_info_easy.get_hist_data((['amazon', 'apple', 'google', 'microsoft']), start_date="01/04/2022", end_date = "2022-01-10") # if don't specify the `end_date`, today's date will be selected by default. 
# To view the stock data as a table, type `data_list` to view all or by company `company_list[i]`, i = index of the company. 
>>> company_list[1]  # stock info of all queried companies.


```python >>> company_list[0] # first company (amazon) info. ```


```python >>> company_list[1] # second company (apple) info. ```



#### 2. Visualization of Closing Price
```python
# To generate a visualization of closing price, copy-paste below function as it is.
>>> get_closing_price_viz(company_list, comp_names) 


3. Visualization of Daily Return

# To generate a visualization of Daily Return, copy-paste below function as it is.
>>> get_daily_return_viz(company_list, company_names)

4. Audio file on Stock Info

This package provides key stock information such as PE ratio and basic company information of all queries companies in an audio format.

>>> generate_audio(comp_names_abbr, audio_filename='default1.mp3') # customize the audio filename; by default, the file will be saved as 'default1.mp3'.

5. Prediction on Closing Price

This package uses the time series LSTM vanila model to predict the closing price. LSTM model is built with two hidden LSTM layers followed by a standard feedforward output layer.

# Write following functions.
# The window size and prediction window size can be customized; by default, they are set as 30 days and 10 days respectively. 

>>> stock_info_easy.predict_future_price(data_list, comp_names_abbr, windown_size=30, predict_window_size=10, predict=True)


Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

stock_info_easy was created by Shauna Han. It is licensed under the terms of the MIT license.

Credits

stock_info_easy was created with cookiecutter and the py-pkgs-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stock_info_easy-1.2.4.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

stock_info_easy-1.2.4-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file stock_info_easy-1.2.4.tar.gz.

File metadata

  • Download URL: stock_info_easy-1.2.4.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Darwin/21.4.0

File hashes

Hashes for stock_info_easy-1.2.4.tar.gz
Algorithm Hash digest
SHA256 4c64b0ced28743ba1cb1fbe203bacf879c908a27965fb164e28f06230b82f15f
MD5 58a5f1af83ced53de91307a75f8437b8
BLAKE2b-256 a068a4460920f32e6212cbbc1d5c84af376256a53deb4907db42823aab13b4be

See more details on using hashes here.

File details

Details for the file stock_info_easy-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: stock_info_easy-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Darwin/21.4.0

File hashes

Hashes for stock_info_easy-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1f5e9ca539b6f4a476298cf39e99634618733d1fc564dba514e62f79713186cb
MD5 e1be4c3b1d8a71794ea950123e70a30f
BLAKE2b-256 ef5ff59b1b49a75f99b79811f72188b31b1abe833d2bd948ad9d73747d27626b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page