rcy222 / stocks-app-py

a skeleton example Stock Recommendation App to help students get started with project development. the "solution-latest-price" branch contains an example partial solution.

Stock Recommendation App

A command-line Python application which processes user inputs and stock market data from the AlphaVantage API to provide stock purchase recommendations.

Installation

First, "fork" this upstream repository under your own control.

Then download your forked version of this repository using the GitHub.com online interface or the Git command-line interface. If you are using command-line Git, you can download it by "cloning" it:

git clone https://github.com/YOUR_USERNAME/stocks-app-py.git

After downloading your forked repository, navigate into its root directory:

cd stocks-app-py/

NOTE: all commands in this document assume you are running them from this root directory.

Install package dependencies using one of the following commands, depending on how you have installed Python and how you are managing packages:

# Pipenv on Mac or Windows:
pipenv install -r requirements.txt

# Homebrew-installed Python 3.x on Mac OS:
pip3 install -r requirements.txt

# All others:
pip install -r requirements.txt

Setup

Obtain an AlphaVantage API Key, which the app will supply when issuing requests to the API.

To prevent your secret API Key from being tracked in version control, the application looks for an environment variable named ALPHAVANTAGE_API_KEY. To set this environment variable, create a new file in this directory called ".env" and place inside the following contents:

ALPHAVANTAGE_API_KEY="abc123" # use your own API Key instead of "abc123"

Usage

If you are using Pipenv, enter a new virtual environment (pipenv shell) before running any of the commands below.

Run the recommendation script:

# Homebrew-installed Python 3.x on Mac OS, not using Pipenv:
python app/robo_adviser.py

# All others, including Pipenv on Mac or Windows:
python app/robo_adviser.py

License