V1.0.2 (#35)

* update version

* added test for predictor

* refactor alpaca.py

* update requirements.txt

Author: TexasCoding

py_alpaca_api/alpaca.py

@@ -14,50 +14,49 @@ class PyAlpacaApi:
     def __init__(self, api_key: str, api_secret: str, api_paper: bool = True):
         """
         Initializes an instance of the Alpaca class.
-
         Args:
             api_key (str): The API key for accessing the Alpaca API.
             api_secret (str): The API secret for accessing the Alpaca API.
             api_paper (bool, optional): Specifies whether to use the Alpaca paper trading API.
                 Defaults to True.
-
         Raises:
             ValueError: If the API key or API secret is not provided.
         """
-        if not api_key:
-            raise ValueError("API Key is required")
-        if not api_secret:
-            raise ValueError("API Secret is required")
 
-        # Set the API Key and Secret
+        # Check API Key and Secret
+        self._validate_api_key_and_secret(api_key, api_secret)
+
+        # Set Headers
         self.headers = {
             "APCA-API-KEY-ID": api_key,
             "APCA-API-SECRET-KEY": api_secret,
         }
 
-        # Set the API URL's
-        if api_paper:
-            self.trade_url = "https://paper-api.alpaca.markets/v2"
-        else:
-            self.trade_url = "https://api.alpaca.markets/v2"
-
+        # Set URLs
         self.data_url = "https://data.alpaca.markets/v2"
+        self.trade_url = self._set_trade_url(api_paper)
+
+        # Initialize Components
+        self._initialize_components()
+
+    @staticmethod
+    def _validate_api_key_and_secret(api_key: str, api_secret: str):
+        if not api_key:
+            raise ValueError("API Key is required")
+        if not api_secret:
+            raise ValueError("API Secret is required")
+
+    @staticmethod
+    def _set_trade_url(api_paper: bool):
+        return "https://paper-api.alpaca.markets/v2" if api_paper else "https://api.alpaca.markets/v2"
 
+    def _initialize_components(self):
         self.account = Account(trade_url=self.trade_url, headers=self.headers)
         self.asset = Asset(trade_url=self.trade_url, headers=self.headers)
         self.history = History(data_url=self.data_url, headers=self.headers, asset=self.asset)
-        self.position = Position(
-            trade_url=self.trade_url,
-            headers=self.headers,
-            account=self.account,
-        )
+        self.position = Position(trade_url=self.trade_url, headers=self.headers, account=self.account)
         self.order = Order(trade_url=self.trade_url, headers=self.headers)
         self.market = Market(trade_url=self.trade_url, headers=self.headers)
         self.watchlist = Watchlist(trade_url=self.trade_url, headers=self.headers)
-        self.screener = Screener(
-            data_url=self.data_url,
-            headers=self.headers,
-            asset=self.asset,
-            market=self.market,
-        )
+        self.screener = Screener(data_url=self.data_url, headers=self.headers, asset=self.asset, market=self.market)
         self.predictor = Predictor(history=self.history, screener=self.screener)

py_alpaca_api/src/predictor.py

@@ -11,7 +11,6 @@
 yesterday = pendulum.now().subtract(days=1).format("YYYY-MM-DD")
 four_years_ago = pendulum.now().subtract(years=2).format("YYYY-MM-DD")
 
-
 logger = logging.getLogger("cmdstanpy")
 logger.disabled = True
 logger.propagate = False

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "py-alpaca-api"
-version = "1.0.1"
+version = "1.0.2"
 description = "Python package, for communicating with Alpaca Markets REST API."
 authors = ["TexasCoding <[email protected]>"]
 license = "MIT"

requirements.txt

@@ -1,12 +1,29 @@
-certifi==2024.2.2 ; python_version >= "3.12" and python_version < "4.0"
+certifi==2024.6.2 ; python_version >= "3.12" and python_version < "4.0"
 charset-normalizer==3.3.2 ; python_version >= "3.12" and python_version < "4.0"
+cmdstanpy==1.2.2 ; python_version >= "3.12" and python_version < "4.0"
+colorama==0.4.6 ; python_version >= "3.12" and python_version < "4.0" and platform_system == "Windows"
+contourpy==1.2.1 ; python_version >= "3.12" and python_version < "4.0"
+cycler==0.12.1 ; python_version >= "3.12" and python_version < "4.0"
+fonttools==4.53.0 ; python_version >= "3.12" and python_version < "4.0"
+holidays==0.49 ; python_version >= "3.12" and python_version < "4.0"
 idna==3.7 ; python_version >= "3.12" and python_version < "4.0"
+importlib-resources==6.4.0 ; python_version >= "3.12" and python_version < "4.0"
+kiwisolver==1.4.5 ; python_version >= "3.12" and python_version < "4.0"
+matplotlib==3.9.0 ; python_version >= "3.12" and python_version < "4.0"
 numpy==1.26.4 ; python_version >= "3.12" and python_version < "4.0"
+packaging==24.0 ; python_version >= "3.12" and python_version < "4.0"
 pandas==2.2.2 ; python_version >= "3.12" and python_version < "4.0"
 pendulum==3.0.0 ; python_version >= "3.12" and python_version < "4.0"
+pillow==10.3.0 ; python_version >= "3.12" and python_version < "4.0"
+plotly==5.22.0 ; python_version >= "3.12" and python_version < "4.0"
+prophet==1.1.5 ; python_version >= "3.12" and python_version < "4.0"
+pyparsing==3.1.2 ; python_version >= "3.12" and python_version < "4.0"
 python-dateutil==2.9.0.post0 ; python_version >= "3.12" and python_version < "4.0"
 pytz==2024.1 ; python_version >= "3.12" and python_version < "4.0"
 requests==2.32.3 ; python_version >= "3.12" and python_version < "4.0"
 six==1.16.0 ; python_version >= "3.12" and python_version < "4.0"
+stanio==0.5.0 ; python_version >= "3.12" and python_version < "4.0"
+tenacity==8.3.0 ; python_version >= "3.12" and python_version < "4.0"
+tqdm==4.66.4 ; python_version >= "3.12" and python_version < "4.0"
 tzdata==2024.1 ; python_version >= "3.12" and python_version < "4.0"
 urllib3==2.2.1 ; python_version >= "3.12" and python_version < "4.0"

tests/test_predictor.py

@@ -0,0 +1,41 @@
+import sys
+from unittest.mock import MagicMock
+
+import pandas as pd
+import pytest
+
+from py_alpaca_api.src.predictor import Predictor
+
+sys.path.append("py_alpaca_api/src")
+
+
+@pytest.fixture(scope="module")
+def predictor():
+    history = MagicMock()
+    screener = MagicMock()
+    return Predictor(history, screener)
+
+
+def test_get_losers_to_gainers_with_exception_handling(predictor):
+    predictor.get_stock_data = MagicMock(return_value=pd.DataFrame())
+    predictor.train_prophet_model = MagicMock(return_value=MagicMock())
+    predictor.generate_forecast = MagicMock(side_effect=Exception("Random error"))
+    assert predictor.get_losers_to_gainers() == []
+
+
+def test_get_losers_to_gainers_when_forecast_price_is_less_than_previous_price(predictor):
+    ticker = "AAPL"
+    predictor.get_stock_data = MagicMock(return_value=pd.DataFrame())
+    predictor.train_prophet_model = MagicMock(return_value=MagicMock())
+    predictor.screener.losers = MagicMock(return_value=pd.DataFrame({"symbol": [ticker], "price": [10]}))
+    predictor.generate_forecast = MagicMock(return_value=5)
+    assert predictor.get_losers_to_gainers() == []
+
+
+def test_get_losers_to_gainers_when_forecast_price_is_greater_than_previous_price(predictor):
+    ticker = "AAPL"
+    predictor.get_stock_data = MagicMock(return_value=pd.DataFrame())
+    predictor.train_prophet_model = MagicMock(return_value=MagicMock())
+    predictor.screener.losers = MagicMock(return_value=pd.DataFrame({"symbol": [ticker], "price": [10.00]}))
+    predictor.generate_forecast = MagicMock(return_value=20.00)
+    assert predictor.get_losers_to_gainers() == [ticker]