OpenSentiment

Get sentimend rating of finance news articles using OpenAI API and Yahoo Finance
Explore the docs »

· Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

About The Project

A simple script that scrapes Yahoo Finance articles for a specific stock and then passes them into the OpenAI API to rate their sentiment

Getting Started

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

Prerequisites

Clone the repository on your machine.

git clone https://github.com/pylyf/OpenSentiment.git

Installation

Install all required libraries in order to execute the script.

pip install -r requirements.txt

Make sure to edit the config.ini file and replace (insert your key here) with your secret API key from https://openai.com/blog/openai-api.

Usage

python main.py

The script will ask you to enter the ticker of the stock (ie. AAPL for the apple company). It will then rate the sentiment of the news articles and print them out in a table format

Contributing

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.

Contact

Filip Komarek - pylyf.kom@gmail.com

Project Link: https://github.com/pylyf/OpenSentiment