Merge pull request #9 from Visionary-Code-Works/dev

thomasthaddeus · web-flow · commit ce858698a08d · 2024-03-23T00:25:47.000-07:00
Dev
diff --git a/.gitignore b/.gitignore
@@ -223,3 +223,4 @@ $RECYCLE.BIN/
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 
+.vscode/
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/docs/finance_apis.csv b/docs/finance_apis.csv
@@ -0,0 +1,9 @@
+API Name,Website,Unique Feature,Pricing
+Alpha Vantage,https://www.alphavantage.co,Wide range of data services; technical indicators,Free/Paid
+IEX Cloud,https://iexcloud.io,Wide array of financial data; tiered pricing model with a free tier,Free/Paid
+Quandl,https://www.quandl.com,"Financial, economic, and alternative data; free datasets available for academic use",Free/Paid
+Financial Modeling Prep,https://financialmodelingprep.com,Broad set of financial data APIs; includes stock market data and financial statements,Free/Paid
+World Trading Data,https://www.worldtradingdata.com,Real-time and historical stock data; free tier available,Free/Paid
+MarketStack,https://marketstack.com,REST API interface to obtain stock market data from around the world; free tier with limited access,Free/Paid
+Finnhub,https://finnhub.io,"Free APIs for stock data, forex, and crypto; both real-time and historical data",Free/Paid
+Twelve Data,https://twelvedata.com,"Financial data including real-time and historical stock data, forex, and cryptocurrencies; free plan with limited access",Free/Paid
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "stock-analysis-program"
-version = "1.0.5"
+version = "1.0.6"
 description = "A Python-based toolkit for fetching and visualizing financial data and metrics for stocks."
 authors = [
     "Thaddeus Thomas <thaddeus.r.thomas@gmail.com>",
@@ -24,13 +24,18 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.11"
-yfinance = "^0.2.33"
-matplotlib = "^3.8.0"
-pandas = "^2.1.1"
+yfinance = "^0.2.37"
+matplotlib = "^3.8.3"
+pandas = "^2.2.1"
 
 [tool.poetry.dev-dependencies]
-pytest = "^7.4.3"
+pytest = "^8.1.1"
+
+[[tool.poetry.source]]
+name = "StockAnalysisProgram"
+url = "https://github.com/Visionary-Code-Works/StockAnalysisProgram"
+priority = "primary"
 
 [build-system]
-requires = ["poetry>=1.71"]
+requires = ["poetry>=1.8.2"]
 build-backend = "poetry.masonry.api"
diff --git a/scripts/finance_apis.py b/scripts/finance_apis.py
@@ -0,0 +1,51 @@
+import pandas as pd
+
+# Creating a DataFrame with details of the finance APIs
+finance_apis = pd.DataFrame(
+    {
+        "API Name": [
+            "Alpha Vantage",
+            "IEX Cloud",
+            "Quandl",
+            "Financial Modeling Prep",
+            "World Trading Data",
+            "MarketStack",
+            "Finnhub",
+            "Twelve Data",
+        ],
+        "Website": [
+            "https://www.alphavantage.co",
+            "https://iexcloud.io",
+            "https://www.quandl.com",
+            "https://financialmodelingprep.com",
+            "https://www.worldtradingdata.com",
+            "https://marketstack.com",
+            "https://finnhub.io",
+            "https://twelvedata.com",
+        ],
+        "Unique Feature": [
+            "Wide range of data services; technical indicators",
+            "Wide array of financial data; tiered pricing model with a free tier",
+            "Financial, economic, and alternative data; free datasets available for academic use",
+            "Broad set of financial data APIs; includes stock market data and financial statements",
+            "Real-time and historical stock data; free tier available",
+            "REST API interface to obtain stock market data from around the world; free tier with limited access",
+            "Free APIs for stock data, forex, and crypto; both real-time and historical data",
+            "Financial data including real-time and historical stock data, forex, and cryptocurrencies; free plan with limited access",
+        ],
+        "Pricing": [
+            "Free/Paid",
+            "Free/Paid",
+            "Free/Paid",
+            "Free/Paid",
+            "Free/Paid",
+            "Free/Paid",
+            "Free/Paid",
+            "Free/Paid",
+        ],
+    }
+)
+
+# Saving the DataFrame to a CSV file
+file_path = "finance_apis.csv"
+finance_apis.to_csv(file_path, index=False)
diff --git a/src/stock_analysis_program/__init__.py b/src/stock_analysis_program/__init__.py
@@ -0,0 +1,16 @@
+# src/__init__.py
+
+from .fetcher import (
+    StockDataFetcher,
+    StockSummaryFetcher,
+    FinancialMetricsFetcher,
+    RevenueGrowthFetcher,
+)
+from .plotter import (
+    StockPricePlotter,
+    FinancialMetricsPlotter,
+    RevenueGrowthPlotter,
+    StockVolatilityPlotter,
+    StockExchangePerformancePlotter,
+    CurrentPricesTickerDisplay,
+)
diff --git a/src/stock_analysis_program/fetcher/__init__.py b/src/stock_analysis_program/fetcher/__init__.py
@@ -1,6 +1,6 @@
 # fetcher/__init__.py
 
-from financial_metrics_fetcher import FinancialMetricsFetcher
-from revenue_growth_fetcher import RevenueGrowthFetcher
-from stock_data_fetcher import StockDataFetcher
-from stock_summary_fetcher import StockSummaryFetcher
+from .financial_metrics_fetcher import FinancialMetricsFetcher
+from .revenue_growth_fetcher import RevenueGrowthFetcher
+from .stock_data_fetcher import StockDataFetcher
+from .stock_summary_fetcher import StockSummaryFetcher
diff --git a/src/stock_analysis_program/fetcher/stock_data_fetcher.py b/src/stock_analysis_program/fetcher/stock_data_fetcher.py
@@ -11,7 +11,6 @@
 """
 
 import yfinance as yf
-import pandas as pd
 
 
 class StockDataFetcher:
diff --git a/src/stock_analysis_program/main.py b/src/stock_analysis_program/main.py
@@ -9,13 +9,11 @@
 plotting capabilities for stocks and financial indices.
 """
 
-from fetcher import (
+from .__init__ import (
     StockDataFetcher,
     StockSummaryFetcher,
     FinancialMetricsFetcher,
     RevenueGrowthFetcher,
-)
-from plotter import (
     StockPricePlotter,
     FinancialMetricsPlotter,
     RevenueGrowthPlotter,
diff --git a/src/stock_analysis_program/plotter/__init__.py b/src/stock_analysis_program/plotter/__init__.py
@@ -1,8 +1,8 @@
 # plotter/__init__.py
 
-from current_prices_ticker_display import CurrentPricesTickerDisplay
-from financial_metrics_plotter import FinancialMetricsPlotter
-from revenue_growth_plotter import RevenueGrowthPlotter
-from stock_exchange_performance_plotter import StockExchangePerformancePlotter
-from stock_price_plotter import StockPricePlotter
-from stock_volatility_plotter import StockVolatilityPlotter
+from .current_prices_ticker_display import CurrentPricesTickerDisplay
+from .financial_metrics_plotter import FinancialMetricsPlotter
+from .revenue_growth_plotter import RevenueGrowthPlotter
+from .stock_exchange_performance_plotter import StockExchangePerformancePlotter
+from .stock_price_plotter import StockPricePlotter
+from .stock_volatility_plotter import StockVolatilityPlotter
diff --git a/src/stock_analysis_program/plotter/current_prices_ticker_display.py b/src/stock_analysis_program/plotter/current_prices_ticker_display.py
@@ -9,9 +9,9 @@
 ticker tape seen in trading platforms or financial news channels.
 """
 
-import yfinance as yf
-import time
 import os
+import time
+import yfinance as yf
 
 class CurrentPricesTickerDisplay:
     """
diff --git a/src/stock_analysis_program/plotter/financial_metrics_plotter.py b/src/stock_analysis_program/plotter/financial_metrics_plotter.py
@@ -12,7 +12,7 @@ class to fetch financial data and then plots these metrics in a histogram
 
 import matplotlib.pyplot as plt
 import pandas as pd
-from fetcher.financial_metrics_fetcher import FinancialMetricsFetcher
+from src.stock_analysis_program.fetcher.financial_metrics_fetcher import FinancialMetricsFetcher
 
 class FinancialMetricsPlotter:
     """A class for plotting financial metrics of stocks.
diff --git a/src/stock_analysis_program/plotter/revenue_growth_plotter.py b/src/stock_analysis_program/plotter/revenue_growth_plotter.py
@@ -8,7 +8,7 @@
 """
 
 import matplotlib.pyplot as plt
-from fetcher.revenue_growth_fetcher import RevenueGrowthFetcher
+from ..fetcher.revenue_growth_fetcher import RevenueGrowthFetcher
 
 
 class RevenueGrowthPlotter:
diff --git a/src/stock_analysis_program/plotter/stock_exchange_performance_plotter.py b/src/stock_analysis_program/plotter/stock_exchange_performance_plotter.py
@@ -11,7 +11,6 @@
 
 import yfinance as yf
 import matplotlib.pyplot as plt
-import pandas as pd
 
 class StockExchangePerformancePlotter:
     """A class for comparing the performance of different stock indices.
diff --git a/src/stock_analysis_program/plotter/stock_volatility_plotter.py b/src/stock_analysis_program/plotter/stock_volatility_plotter.py
@@ -9,7 +9,6 @@
 
 import yfinance as yf
 import matplotlib.pyplot as plt
-import pandas as pd
 
 
 class StockVolatilityPlotter:
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1,17 @@
+# tests/__init__.py
+
+from .test_fetcher import (
+    test_financial_metrics_fetcher,
+    test_revenue_growth_fetcher_initialization,
+    test_stock_data_fetcher,
+    test_stock_summary_fetcher_initialization
+)
+from .test_plotter import (
+    test_current_prices_ticker_display_initialization,
+    test_financial_metrics_plotter,
+    test_revenue_growth_plotter_initialization,
+    test_stock_exchange_performance_plotter,
+    test_stock_price_plotter_initialization,
+    test_stock_volatility_plotter_initialization
+)
+from .test_main import test_main_exists
diff --git a/tests/test_fetcher/__init__.py b/tests/test_fetcher/__init__.py
@@ -0,0 +1,6 @@
+# tests/test_fetcher/__init__.py
+
+from .test_financial_metrics_fetcher import test_financial_metrics_fetcher
+from .test_revenue_growth_fetcher import test_revenue_growth_fetcher_initialization
+from .test_stock_data_fetcher import test_stock_data_fetcher
+from .test_stock_summary_fetcher import test_stock_summary_fetcher_initialization
diff --git a/tests/test_fetcher/test_financial_metrics_fetcher.py b/tests/test_fetcher/test_financial_metrics_fetcher.py
@@ -1,9 +1,9 @@
 # tests/test_fetcher/test_financial_metrics_fetcher.py
 
 import pytest
-from src.fetcher.financial_metrics_fetcher import FinancialMetricsFetcher
+from src.stock_analysis_program.fetcher import FinancialMetricsFetcher
 
 def test_financial_metrics_fetcher():
     fetcher = FinancialMetricsFetcher(['AAPL'])
     metrics = fetcher.fetch_financial_metrics()
-    assert 'AAPL' in metrics, "AAPL should be in the fetched financial metrics."
+    assert 'AAPL' in metrics['Ticker'].values, "AAPL should be in the fetched financial metrics."
diff --git a/tests/test_fetcher/test_revenue_growth_fetcher.py b/tests/test_fetcher/test_revenue_growth_fetcher.py
@@ -1,7 +1,7 @@
 # tests/test_fetcher/test_revenue_growth_fetcher.py
 
 import pytest
-from src.fetcher.revenue_growth_fetcher import RevenueGrowthFetcher
+from src.stock_analysis_program import RevenueGrowthFetcher
 
 def test_revenue_growth_fetcher_initialization():
     fetcher = RevenueGrowthFetcher(["AAPL"])
diff --git a/tests/test_fetcher/test_stock_data_fetcher.py b/tests/test_fetcher/test_stock_data_fetcher.py
@@ -1,7 +1,7 @@
 # tests/test_fetcher/test_stock_data_fetcher.py
 
 import pytest
-from src.fetcher.stock_data_fetcher import StockDataFetcher
+from src.stock_analysis_program import StockDataFetcher
 
 def test_stock_data_fetcher():
     fetcher = StockDataFetcher("AAPL")
diff --git a/tests/test_fetcher/test_stock_summary_fetcher.py b/tests/test_fetcher/test_stock_summary_fetcher.py
@@ -1,7 +1,7 @@
 # tests/test_fetcher/test_stock_summary_fetcher.py
 
 import pytest
-from src.fetcher.stock_summary_fetcher import StockSummaryFetcher
+from src.stock_analysis_program import StockSummaryFetcher
 
 def test_stock_summary_fetcher_initialization():
     fetcher = StockSummaryFetcher(["AAPL"])
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -1,7 +1,7 @@
 # tests/test_main.py
 
 import pytest
-from src import main
+from src.stock_analysis_program import main
 
 def test_main_exists():
     assert main is not None, "Main module should exist."
diff --git a/tests/test_plotter/__init__.py b/tests/test_plotter/__init__.py
@@ -0,0 +1,8 @@
+# tests/test_fetcher/__init__.py
+
+from .test_current_prices_ticker_display import test_current_prices_ticker_display_initialization
+from .test_financial_metrics_plotter import test_financial_metrics_plotter
+from .test_revenue_growth_plotter import test_revenue_growth_plotter_initialization
+from .test_stock_exchange_performance_plotter import test_stock_exchange_performance_plotter
+from .test_stock_price_plotter import test_stock_price_plotter_initialization
+from .test_stock_volatility_plotter import test_stock_volatility_plotter_initialization
diff --git a/tests/test_plotter/test_current_prices_ticker_display.py b/tests/test_plotter/test_current_prices_ticker_display.py
@@ -1,7 +1,7 @@
 # tests/test_plotter/test_current_prices_ticker_display.py
 
 import pytest
-from src.plotter.current_prices_ticker_display import CurrentPricesTickerDisplay
+from src.stock_analysis_program import CurrentPricesTickerDisplay
 
 def test_current_prices_ticker_display_initialization():
     display = CurrentPricesTickerDisplay(["AAPL"], 10)
diff --git a/tests/test_plotter/test_financial_metrics_plotter.py b/tests/test_plotter/test_financial_metrics_plotter.py
@@ -1,9 +1,43 @@
 # tests/test_fetcher/test_financial_metrics_fetcher.py
 
+from unittest.mock import patch
 import pytest
-from src.fetcher.financial_metrics_fetcher import FinancialMetricsFetcher
+import pandas as pd
+from src.stock_analysis_program.plotter.financial_metrics_plotter import (
+    FinancialMetricsPlotter,
+)
 
-def test_financial_metrics_fetcher():
-    fetcher = FinancialMetricsFetcher(['AAPL'])
-    metrics = fetcher.fetch_financial_metrics()
-    assert 'AAPL' in metrics, "AAPL should be in the fetched financial metrics."
+# Adjust the sample data to be a DataFrame instead of a dict
+sample_financial_data = pd.DataFrame(
+    {
+        "Ticker": ["AAPL", "MSFT"],
+        "Market Cap": [1000000, 2000000],
+        "PE Ratio": [25, 30],
+        # Add more columns as needed
+    }
+)
+
+
+@pytest.fixture
+def mock_fetcher_return():
+    """Fixture to mock the FinancialMetricsFetcher's return value as a DataFrame."""
+    return sample_financial_data
+
+
+@patch(
+    "src.stock_analysis_program.plotter.financial_metrics_plotter.FinancialMetricsFetcher"
+)
+def test_financial_metrics_plotter(mock_FinancialMetricsFetcher, mock_fetcher_return):
+    """Test the FinancialMetricsPlotter's plot_metrics method."""
+    # Setup mock to return the sample financial data as a DataFrame
+    mock_instance = mock_FinancialMetricsFetcher.return_value
+    mock_instance.fetch_financial_metrics.return_value = mock_fetcher_return
+
+    # Initialize the plotter with mock data
+    plotter = FinancialMetricsPlotter(["AAPL", "MSFT"])
+
+    with patch("matplotlib.pyplot.show"):
+        plotter.plot_metrics()
+
+    # Assert fetch_financial_metrics was called
+    mock_instance.fetch_financial_metrics.assert_called_once()
diff --git a/tests/test_plotter/test_revenue_growth_plotter.py b/tests/test_plotter/test_revenue_growth_plotter.py
diff --git a/tests/test_plotter/test_stock_exchange_performance_plotter.py b/tests/test_plotter/test_stock_exchange_performance_plotter.py
diff --git a/tests/test_plotter/test_stock_price_plotter.py b/tests/test_plotter/test_stock_price_plotter.py
diff --git a/tests/test_plotter/test_stock_volatility_plotter.py b/tests/test_plotter/test_stock_volatility_plotter.py

Original file line number	Diff line number	Diff line change
`@@ -223,3 +223,4 @@ $RECYCLE.BIN/`
`223`	`223`
`224`	`224`	`# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)`
`225`	`225`
	`226`	`+.vscode/`