mattrcarroll / stock-ticker

Real-time stock indices and tickers inside your terminal.

Stock-Ticker

Real-time stock indices and tickers in your terminal

Report Bug · Request Feature

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Acknowledgements

About The Project

stock-ticker.py is a python script using the Yahoo Finance API v7 as a data source. Major stock indices and currencies are printed out by standard and is then followed by the stock symbols provided by the user. The script will run every 5 minutes.

Built With

• Python 3.7.6

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Python 3

# Install via brew on macOS
brew install python

For Linux and Windows refer to this.

Installation

1: Fork the repository (using the Fork button at the top)

2: Clone the repository

# Replace {YOUR_USERNAME} with your actual username
git clone https://github.com/{YOUR_USERNAME}/stock-ticker.git

3: Change directory into stock-ticker

cd stock-ticker

4: Install python requirements

pip3 install -r requirements.txt

Usage

• Single stock symbol

python3 stock-ticker.py AAPL

• Multiple stock symbols

python3 stock-ticker.py FB AAPL AMZN NFLX GOOG

• Text file with multiple stock symbols

python3 stock-ticker.py watchlist.txt

• watchlist.txt: add your stock symbols line per line

FB
AAPL
AMZN
NFLX
GOOG

• To stop the script, use ctrl-c inside your terminal.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• Yahoo Finance API v7
• pandas
• colorama