/FiBot

Enlighten Your Investment Strategy.

Primary LanguagePythonMIT LicenseMIT

FiBot - Enlighten Your Investment Strategy

Started: January 9, 2024 Ended: August 23, 2024

FiBot is a Flask-based web application that allows users to easily look up stock tickers by company name and retrieve detailed financial information and recent news about the companies.

Screenshots

Here are some screenshots showcasing the interface:

image_search image_ticker

Features

  • Company Name to Ticker Conversion:
    Simply input a company name, and FiBot will retrieve the corresponding stock ticker, along with the exchange where the stock is listed.

  • Detailed Ticker Information:
    Click on a ticker to access a comprehensive overview of the stock, including sector, industry, current price, beta, day range, previous close, and more.

  • Latest News Integration:
    Stay updated with the latest news articles related to the selected company. FiBot displays the most recent news with links to full articles.

Technologies and Libraries

Web Scraping

FiBot uses web scraping techniques to gather the latest stock information and news directly from financial websites. In FiBot, this is primarily achieved using the following tools:

  • Selenium: A powerful web scraping tool that automates browser actions, allowing FiBot to interact with dynamic web pages and extract information such as company names, tickers, and related news articles.
  • yfinance: A library to fetch detailed financial data for specific stock tickers. yfinance is a Python library that wraps the Yahoo Finance API, enabling easy access to stock market data.

Project Structure

app/
├── app.py                   # Main Flask application script
├── templates/               # HTML templates
│   ├── base.html            # Base template for common layout
│   ├── index.html           # Home page template
│   ├── ticker.html          # Ticker details page template
├── static/
│   ├── styles.css           # Custom CSS styles
│   ├── img/                 # File containing screenshots
├── functions.py             # Helper functions for data retrieval
└── README.md                # Project documentation

How to Run the Project

  1. Clone the Repository:
git clone https://github.com/mdkwe/FiBot.git
cd Fibot
  1. Create a Virtual Environment:
  • Unix/MacOS: 
    python3 -m venv venv
source venv/bin/activate
  • Windows: 
    python -m venv venv
venv\\Scripts\\activate
  1. Install Dependencies:
pip install -r requirements.txt

  1. Run the Flask Application:

    python app/app.py

    The application will be accessible at http://127.0.0.1:5000/.

  2. Access the Application:

    • Home Page: Enter a company name to retrieve its ticker and exchange information.
    • Ticker Details: Click on a ticker from the results to view more detailed information, including the latest news.

Templates Overview

  • base.html
    Defines the basic layout of the application, including the navigation and content sections, with a home icon for easy navigation.

  • index.html
    Contains a form for users to input a company name and a table to display search results.

  • ticker.html
    Displays detailed information about a specific stock ticker, including key financial metrics and recent news.

License

This project is licensed under the MIT License. See the LICENSE file for more details.