Bring examples to their own directory

Author: pythonfortraders

examples/__init__.py

@@ -0,0 +1,101 @@
+import sys
+import os
+from functools import wraps
+
+# Add the parent directory to sys.path
+sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+from src.stocks_historical import ThetaDataStocksHistorical
+
+historical_data = ThetaDataStocksHistorical(enable_logging=True, use_df=True)
+
+
+def example_runner(func):
+    """
+    A decorator that wraps functions to provide consistent logging and output formatting.
+
+    This decorator does the following:
+    1. Generates a human-readable description from the function name.
+    2. Executes the wrapped function and captures its result.
+    3. Logs appropriate messages based on the result:
+       - Warns if the result is None (indicating a failure to retrieve data).
+       - Warns if the result is an empty DataFrame.
+       - Logs an info message if data was successfully received.
+    4. Prints the description and the result to the console if data was received.
+
+    Args:
+        func (callable): The function to be wrapped.
+
+    Returns:
+        callable: The wrapped function with added logging and output formatting.
+    """
+
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        description = func.__name__.replace("_", " ").title()
+        result = func(*args, **kwargs)
+
+        if result is None:
+            historical_data.logger.warning(f"Failed to get {description}")
+        elif result.empty:
+            historical_data.logger.warning(f"{description} is empty")
+        else:
+            historical_data.logger.info(f"{description} received")
+            print(f"\n{description}:")
+            print(result)
+
+    return wrapper
+
+
+@example_runner
+def apple_eod_example():
+    return historical_data.get_eod_report("AAPL", "20240101", "20240131")
+
+
+@example_runner
+def microsoft_quotes_example():
+    return historical_data.get_quotes(
+        "MSFT", "20240101", "20240131", interval="3600000"
+    )
+
+
+@example_runner
+def google_ohlc_example():
+    return historical_data.get_ohlc("GOOGL", "20240101", "20240131", interval="3600000")
+
+
+@example_runner
+def tesla_trades_example():
+    return historical_data.get_trades("TSLA", "20240101", "20240102")
+
+
+@example_runner
+def amazon_trade_quote_example():
+    return historical_data.get_trade_quote("AMZN", "20240101", "20240102")
+
+
+@example_runner
+def nvidia_splits_example():
+    return historical_data.get_splits("NVDA", "20230101", "20240131")
+
+
+@example_runner
+def intel_dividends_example():
+    return historical_data.get_dividends("INTC", "20230101", "20240131")
+
+
+# Toggle example cases
+if __name__ == "__main__":
+    run_examples = {
+        "apple_eod_example": False,
+        "microsoft_quotes_example": False,
+        "google_ohlc_example": False,
+        "tesla_trades_example": False,
+        "amazon_trade_quote_example": True,
+        "nvidia_splits_example": True,
+        "intel_dividends_example": True,
+    }
+
+    for example, should_run in run_examples.items():
+        if should_run:
+            globals()[example]()

examples/get_historical_data.py

@@ -423,108 +423,3 @@ def get_dividends(
             return pd.DataFrame(data, columns=columns)
         else:
             return response
-
-
-# Usage examples
-
-if __name__ == "__main__":
-    # Toggle example cases
-    run_apple_eod_example = False
-    run_microsoft_quotes_example = False
-    run_google_ohlc_example = False
-    run_tesla_trades_example = False
-    run_amazon_trade_quote_example = True
-    run_nvidia_splits_example = True
-    run_intel_dividends_example = True
-
-    historical_data = ThetaDataStocksHistorical(enable_logging=True, use_df=True)
-
-    # Example 1: Get EOD report for AAPL
-    if run_apple_eod_example:
-        apple_eod = historical_data.get_eod_report("AAPL", "20240101", "20240131")
-        if apple_eod is None:
-            historical_data.logger.warning("Failed to get Apple EOD Report")
-        elif apple_eod.empty:
-            historical_data.logger.warning("Apple EOD Report is empty")
-        else:
-            historical_data.logger.info("Apple EOD Report received")
-            print("Apple EOD Report:")
-            print(apple_eod)
-
-    # Example 2: Get quotes for MSFT
-    if run_microsoft_quotes_example:
-        microsoft_quotes = historical_data.get_quotes(
-            "MSFT", "20240101", "20240131", interval="3600000"
-        )
-        if microsoft_quotes is None:
-            historical_data.logger.warning("Failed to get Microsoft Quotes")
-        elif microsoft_quotes.empty:
-            historical_data.logger.warning("Microsoft Quotes data is empty")
-        else:
-            historical_data.logger.info("Microsoft Quotes received")
-            print("\nMicrosoft Quotes:")
-            print(microsoft_quotes)
-
-    # Example 3: Get OHLC for GOOGL
-    if run_google_ohlc_example:
-        google_ohlc = historical_data.get_ohlc(
-            "GOOGL", "20240101", "20240131", interval="3600000"
-        )
-        if google_ohlc is None:
-            historical_data.logger.warning("Failed to get Google OHLC data")
-        elif google_ohlc.empty:
-            historical_data.logger.warning("Google OHLC data is empty")
-        else:
-            historical_data.logger.info("Google OHLC data received")
-            print("\nGoogle OHLC data:")
-            print(google_ohlc)
-
-    # Example 4: Get trades for TSLA
-    if run_tesla_trades_example:
-        tesla_trades = historical_data.get_trades("TSLA", "20240101", "20240102")
-        if tesla_trades is None:
-            historical_data.logger.warning("Failed to get Tesla Trades data")
-        elif tesla_trades.empty:
-            historical_data.logger.warning("Tesla Trades data is empty")
-        else:
-            historical_data.logger.info("Tesla Trades data received")
-            print("\nTesla Trades data:")
-            print(tesla_trades)
-
-    # Example 5: Get trade quotes for AMZN
-    if run_amazon_trade_quote_example:
-        amazon_trade_quotes = historical_data.get_trade_quote(
-            "AMZN", "20240101", "20240102"
-        )
-        if amazon_trade_quotes is None:
-            historical_data.logger.warning("Failed to get Amazon Trade Quotes data")
-        elif amazon_trade_quotes.empty:
-            historical_data.logger.warning("Amazon Trade Quotes data is empty")
-        else:
-            historical_data.logger.info("Amazon Trade Quotes data received")
-            print("\nAmazon Trade Quotes data:")
-            print(amazon_trade_quotes)
-
-    # Example 6: Get splits for NVDA
-    if run_nvidia_splits_example:
-        nvidia_splits = historical_data.get_splits("NVDA", "20230101", "20240131")
-        if nvidia_splits is None:
-            historical_data.logger.warning("Failed to get NVIDIA Splits data")
-        elif nvidia_splits.empty:
-            historical_data.logger.warning("NVIDIA Splits data is empty")
-        else:
-            historical_data.logger.info("NVIDIA Splits data received")
-            print("\nNVIDIA Splits data:")
-            print(nvidia_splits)
-
-    # Example 7: Get dividends for INTC
-    if run_intel_dividends_example:
-        intel_dividends = historical_data.get_dividends("INTC", "20230101", "20240131")
-        if intel_dividends is None:
-            historical_data.logger.warning("Failed to get Intel Dividends data")
-        elif intel_dividends.empty:
-            historical_data.logger.warning("Intel Dividends data is empty")
-        else:
-            historical_data.logger.info("Intel Dividends data received")
-            print("\nIntel Dividends data:")
-            print(intel_dividends)