Metadata-Version: 2.1
Name: stock-analysis-program
Version: 1.0.0
Summary: A Python-based toolkit for fetching and visualizing financial data and metrics for stocks.
Home-page: https://github.com/visionarycodeworks/stock-analysis-program
Author: Thaddeus Thomas
Author-email: thaddeus.r.thomas@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yfinance
Requires-Dist: matplotlib
Requires-Dist: pandas

Stock Analysis Program
======================

Overview
--------

The Stock Analysis Program is a Python-based toolkit designed to fetch and visualize financial data and metrics for stocks. It is ideal for financial analysts, traders, and anyone interested in stock market analysis. The program offers functionalities such as retrieving historical stock data, computing moving averages, analyzing revenue growth, and plotting financial metrics.

Features
--------

* **Data Fetching**: Retrieve historical data, financial summaries, and key metrics for stocks.
* **Data Visualization**: Visualize stock prices, financial metrics, and revenue growth.
* **Comparative Analysis**: Compare performance of different stocks and stock indices.
* **Customizability**: Modular design allows for easy customization and extension.

Installation
------------

To use this program, ensure you have Python installed on your system. Clone this repository and install the required dependencies:

.. code-block:: bash

   git clone https://github.com/visionary-code-works/stock-analysis-program.git
   cd stock-analysis-program
   pip install -r requirements.txt

Usage
-----

The program consists of multiple Python classes categorized into Fetchers and Plotters.

### Fetchers

* ``StockDataFetcher``
* ``StockSummaryFetcher``
* ``FinancialMetricsFetcher``
* ``RevenueGrowthFetcher``

### Plotters

* ``StockPricePlotter``
* ``FinancialMetricsPlotter``
* ``RevenueGrowthPlotter``
* ``StockVolatilityPlotter``
* ``StockExchangePerformancePlotter``
* ``CurrentPricesTickerDisplay``

### Example

.. code-block:: python

   from plotter.stock_price_plotter import StockPricePlotter

   # Plotting stock prices for Apple and Microsoft
   price_plotter = StockPricePlotter(['AAPL', 'MSFT'])
   price_plotter.plot_closing_prices('2021-01-01', '2021-12-31')

Documentation
-------------

For detailed documentation on each component, please refer to the ``docs`` directory.

Contributing
------------

Contributions to enhance the program are welcome. Please fork the repository and submit a pull request with your changes.

License
-------

This project is licensed under the MIT License - see the LICENSE file for details.
