Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 3.36 KB

developer_guide.md

File metadata and controls

75 lines (51 loc) · 3.36 KB
Raw

Developer guide for market-monitor

This is a short developer guide for anybody planning to develop an app like market-monitor. The app is pretty light-weight with 2 core files containing most of the code. Instead of restating everything, I have added links where there is better info available. Let's dive in.

Financial APIs

The live data that powers the app is coming from Yahoo Finance and Finviz platforms. Instead of webscraping, fortunately there exist python packages which provide access to the data with minimal or no setup and intuitive design. Getting familiar with their functions will make it easy to understand the functions written on top of it.

Functions

There are 3 core functions that play with the APIs to generate content for the 3 main pages. All of them lie in ~/scripts/functions.py file. Go through the in-depth docstrings (by clicking on function name) to learn more about it.

Use Function Description
Stocks stock_chart(stock_object, period)] Returns an interactive dash plot of stock price against time periods.
Options options_table(stock_object, date, kind) Returns the options info of a stock on any given date in tabular format.
News get_news_markdown(ticker_symbol, count) Returns a markdown text string which has count top news sources.

Learning Dash

Dash is a great tool to create interactive apps using Python. I have found it very user-friendly and easy to pick up. Following are great links to get started on it.

Installation and Deployment

Step 1:

Create a new conda environment. I am using python 3.6 and setting env name as market-monitor. Once created activate the environment.

  conda create -n market-monitor python=3.6 -y
  source activate market-monitor

Step 2:

Install requirements listed out in the requirements.txt file.

  pip install -r requirements.txt

Step 3:

Run the app locally

  python stock_chart_app.py

Now that you have it running locally, feel free to make some changes and play with the code.

Once you feel you want to deploy your own app, we need to use a platform to deploy it on. Heroku is one such platform as a service (PaaS) option that enables developers to build, r un, and operate applications entirely in the cloud. They let you host one app for free which should be enough.

Dash already has a great tutorial on how-to host your dash app on Heroku so I will just link it here.

That's about it.
Please reach out if you have any more questions.