data-retrieval-module 1.0.0__tar.gz → 1.0.1__tar.gz

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/CHANGELOG.md

@@ -42,6 +42,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - CI/CD ready setup
 - Package publishing configuration
 
+## [1.0.1] - 2026-01-25
+
+### Added
+- Foreign Exchange data provider module
+  - `Forex_DataProvider_Base` abstract base class for forex data providers
+  - `ForexPython_DataProvider` concrete implementation using Python libraries
+  - `Forex_DataProvider_Wrapper` wrapper for enhanced functionality
+- Utility modules
+  - `date_utils` module for date/time utilities
+- Enhanced data provider wrapper functionality
+- Examples for forex data sources
+
+### Features
+- **Forex Data Support**: Complete foreign exchange data provider framework
+- **Utility Functions**: Date and time utilities for data processing
+- **Enhanced Wrappers**: Improved data provider wrapper capabilities
+- **Example Code**: Forex data source examples and usage patterns
+
+### Documentation
+- Added forex provider documentation
+- Updated package exports to include new modules
+- Enhanced examples with forex data sources
+
 ## [Unreleased]
 
 ### Planned

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-retrieval-module
-Version: 1.0.0
+Version: 1.0.1
 Summary: A standardized interface for data providers with sync and async support
 Author-email: AbigailWilliams1692 <abigail.williams@example.com>
 Maintainer-email: AbigailWilliams1692 <abigail.williams@example.com>
@@ -28,6 +28,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typing-extensions>=4.0.0; python_version < "3.10"
+Requires-Dist: forex-python>=1.0.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval/__init__.py

@@ -30,6 +30,13 @@ from data_retrieval.data_provider.rest_api import RestAPI_DataProvider
 # Database providers
 from data_retrieval.data_provider.database import Database_DataProvider
 
+# Foreign Exchange providers
+from data_retrieval.foreign_exchange import (
+    Forex_DataProvider_Base,
+    ForexPython_DataProvider,
+    Forex_DataProvider_Wrapper
+)
+
 #######################################################################
 # Public API
 #######################################################################
@@ -51,11 +58,16 @@ __all__ = [
     
     # Database providers
     "Database_DataProvider",
+    
+    # Foreign Exchange providers
+    "Forex_DataProvider_Base",
+    "ForexPython_DataProvider",
+    "Forex_DataProvider_Wrapper",
 ]
 
 #######################################################################
 # Version Information
 #######################################################################
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 __author__ = "AbigailWilliams1692"
 __email__ = "abigail.williams@example.com"

data_retrieval_module-1.0.1/data_retrieval/foreign_exchange/__init__.py

@@ -0,0 +1,3 @@
+from data_retrieval.foreign_exchange.forex_data_provider_base import Forex_DataProvider_Base
+from data_retrieval.foreign_exchange.forex_python_data_provider import ForexPython_DataProvider
+from data_retrieval.foreign_exchange.forex_data_provider_wrapper import Forex_DataProvider_Wrapper

data_retrieval_module-1.0.1/data_retrieval/foreign_exchange/forex_data_provider_base.py

@@ -0,0 +1,140 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: forex_data_provider_base.py
+# Description: Forex Data Provider Base
+# Author: AbigailWilliams1692
+# Created: 2026-01-24
+# Updated: 2026-01-24
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import datetime
+import logging
+from abc import ABC, abstractmethod
+from typing import (
+    Dict,
+    List,
+    Optional,
+    Union,
+)
+
+# Third-Party Packages
+
+# Local Packages
+from data_retrieval.model import DataProvider
+
+
+#######################################################################
+# Base Class
+#######################################################################
+class Forex_DataProvider_Base(DataProvider, ABC):
+    """
+    Forex Data Provider Base Class
+    """
+
+    #################################################
+    # Class Attributes
+    #################################################
+    __name: str = "Forex_DataProvider_Base"
+    __type: str = "DataProvider"
+
+    #################################################
+    # Constructor
+    #################################################
+    def __init__(
+        self,
+        instance_id: Optional[int] = None,
+        logger: Optional[logging.Logger] = None,
+        log_level: Optional[int] = logging.INFO,
+        **config,
+    ) -> None:
+        """
+        Initialize the data provider.
+
+        :param instance_id: Unique identifier for this provider instance.
+        :param logger: Logger instance for logging operations.
+        :param log_level: Logging level for the provider.
+        :param config: Additional configuration parameters.
+        """
+        # Initialize the base DataModule
+        super().__init__(
+            instance_id=instance_id,
+            logger=logger,
+            log_level=log_level,
+            **config
+        )
+
+        # Update the data methods
+        self.update_data_methods(
+            new_methods={
+                "exchange_rate_on_spot": self.get_exchange_rate_on_spot,
+                "exchange_rate_historical": self.get_exchange_rates_historical,
+            }
+        )
+
+    #################################################
+    # Connection Methods
+    #################################################
+    @abstractmethod
+    def _connect(self) -> None:
+        """
+        Connect to the data source.
+        """
+        raise NotImplementedError("Subclasses must implement this method")
+    
+    @abstractmethod
+    def _disconnect(self) -> None:
+        """
+        Disconnect from the data source.
+        """
+        raise NotImplementedError("Subclasses must implement this method")
+
+    #################################################
+    # Core Instance Methods
+    #################################################
+    @abstractmethod
+    def get_exchange_rate_on_spot(self, 
+        base_currency: str, 
+        target_currency: str, 
+        fx_datetime: Optional[Union[datetime.datetime, datetime.date]] = None,
+        *args,
+        **kwargs,
+    ) -> float:
+        """
+        Get the exchange rate for a given currency pair on the current date.
+        
+        :param base_currency: The base currency code (e.g., 'USD').
+        :param target_currency: The target currency code (e.g., 'EUR').
+        :param fx_datetime: The timestamp for the exchange rate. (could be datetime or date)
+        :param args: Additional positional arguments.
+        :param kwargs: Additional keyword arguments.
+        :return: The exchange rate as a float.
+        """
+        raise NotImplementedError("Subclasses must implement this method")
+    
+    @abstractmethod
+    def get_exchange_rates_historical(
+        self,
+        base_currency: str, 
+        target_currencies: List[str], 
+        fx_datetime_start: Union[datetime.datetime, datetime.date],
+        fx_datetime_end: Union[datetime.datetime, datetime.date],
+        *args,
+        **kwargs,
+    ) -> Dict[str, Dict[str, float]]:
+        """
+        Get the exchange rates for a base currency and multiple target currencies over a time range.
+        
+        :param base_currency: The base currency code (e.g., 'USD').
+        :param target_currencies: The target currency codes (e.g., ['EUR', 'GBP']).
+        :param fx_datetime_start: The start timestamp for the exchange rate. (could be datetime or date)
+        :param fx_datetime_end: The end timestamp for the exchange rate. (could be datetime or date)
+        :param args: Additional positional arguments.
+        :param kwargs: Additional keyword arguments.
+        :return: A dictionary mapping dates to exchange rates.
+        """
+        raise NotImplementedError("Subclasses must implement this method")
+

data_retrieval_module-1.0.1/data_retrieval/foreign_exchange/forex_data_provider_wrapper.py

@@ -0,0 +1,148 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: forex_data_provider_wrapper.py
+# Description: Forex Data Provider Wrapper
+# Author: AbigailWilliams1692
+# Created: 2026-01-24
+# Updated: 2026-01-24
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import datetime
+import logging
+from typing import (
+    Any,
+    Dict, 
+    List, 
+    Optional,
+    Union,
+)
+
+# Third-party Packages
+
+# Local Packages
+from data_retrieval.model import DataProvider_Wrapper
+from data_retrieval.foreign_exchange.forex_data_provider_base import Forex_DataProvider_Base
+from data_retrieval.foreign_exchange.forex_python_data_provider import ForexPython_DataProvider
+
+
+#######################################################################
+# Forex Data Provider (Synchronous)
+#######################################################################
+class Forex_DataProvider_Wrapper(DataProvider_Wrapper):
+    """
+    Foreign Exchange Data Provider Wrapper.
+    
+    This class provides a standard wrapper interface for retrieving Foreign Exchange data from various sources.
+    """
+
+    #################################################
+    # Class Attributes
+    #################################################
+    __name: str = "Forex_DataProvider_Wrapper"
+    __type: str = "DataProvider_Wrapper"
+    __valid_data_sources = [
+        "forex-python",
+        "exchange_rate_api",
+    ]
+    __valid_data_source_mapping = {
+        "forex-python": ForexPython_DataProvider,
+        "exchange_rate_api": None,
+    }
+
+    #################################################
+    # Constructor
+    #################################################
+    def __init__(
+        self,
+        data_source: str = "forex-python",
+        instance_id: Optional[int] = None,
+        logger: Optional[logging.Logger] = None,
+        log_level: Optional[int] = logging.INFO,
+        **config,
+    ) -> None:
+        """
+        Initialize the Forex Data Provider.
+
+        :param instance_id: Unique identifier for this provider instance.
+        :param logger: Logger instance for logging operations.
+        :param log_level: Logging level for the provider.
+        :param data_methods: Dictionary of data retrieval methods.
+        :param config: Additional configuration parameters.
+        """
+        # Initialize the base DataProvider
+        super().__init__(
+            data_source=data_source,
+            instance_id=instance_id,
+            logger=logger,
+            log_level=log_level,
+            valid_data_sources=self.__valid_data_sources,
+            valid_data_source_mapping=self.__valid_data_source_mapping,
+            **config,
+        )
+
+    #################################################
+    # Core Instance Method: Get Exchange Rate
+    #################################################
+    def get_exchange_rate_on_spot(
+        self, 
+        base_currency: str, 
+        target_currency: str, 
+        fx_datetime: Optional[Union[datetime.datetime, datetime.date]] = None,
+        *args,
+        **kwargs,
+    ) -> Any:
+        """
+        Get the exchange rate for a given currency pair on the current date.
+        
+        :param base_currency: The base currency code (e.g., 'USD').
+        :param target_currency: The target currency code (e.g., 'EUR').
+        :param fx_datetime: The timestamp for the exchange rate. (could be datetime or date)
+        :param args: Additional positional arguments.
+        :param kwargs: Additional keyword arguments.
+        :return: The exchange rate as a float.
+        """
+        return self.fetch_data(
+            data_point="exchange_rate_on_spot",
+            return_data_type=float,
+            base_currency=base_currency,
+            target_currency=target_currency,
+            fx_datetime=fx_datetime,
+            *args,
+            **kwargs,
+        )
+
+    def get_exchange_rates_historical(
+        self,
+        base_currency: str, 
+        target_currencies: List[str], 
+        fx_datetime_start: Union[datetime.datetime, datetime.date],
+        fx_datetime_end: Union[datetime.datetime, datetime.date],
+        *args,
+        **kwargs,
+    ) -> Any:
+        """
+        Get the exchange rates for a base currency and multiple target currencies over a time range.
+        
+        :param base_currency: The base currency code (e.g., 'USD').
+        :param target_currencies: The target currency codes (e.g., ['EUR', 'GBP']).
+        :param fx_datetime_start: The start timestamp for the exchange rate. (could be datetime or date)
+        :param fx_datetime_end: The end timestamp for the exchange rate. (could be datetime or date)
+        :param args: Additional positional arguments.
+        :param kwargs: Additional keyword arguments.
+        :return: The exchange rate as a float.
+        """
+        return self.fetch_data(
+            data_point="exchange_rate_historical",
+            return_data_type=Dict,
+            base_currency=base_currency,
+            target_currencies=target_currencies,
+            fx_datetime_start=fx_datetime_start,
+            fx_datetime_end=fx_datetime_end,
+            *args,
+            **kwargs,
+        )   
+    

data_retrieval_module-1.0.1/data_retrieval/foreign_exchange/forex_python_data_provider.py

@@ -0,0 +1,161 @@
+######################################################################
+# Project: Data Retrieval Module
+# File: forex_data_provider_base.py
+# Description: Forex Data Provider Base
+# Author: AbigailWilliams1692
+# Created: 2026-01-24
+# Updated: 2026-01-24
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import datetime
+import logging
+from typing import (
+    Dict,
+    List,
+    Optional,
+    Union,
+)
+
+# Third-Party Packages
+from forex_python.converter import CurrencyCodes
+from forex_python.converter import CurrencyRates
+from forex_python.bitcoin import BtcConverter
+
+# Local Packages
+from data_retrieval.foreign_exchange.forex_data_provider_base import Forex_DataProvider_Base
+from data_retrieval.utils.date_utils import populate_dates_in_between
+
+
+#######################################################################
+# Forex Python Data Provider Class
+#######################################################################
+class ForexPython_DataProvider(Forex_DataProvider_Base):
+    """
+    Forex Python Data Provider Class
+    """
+
+    #################################################
+    # Class Attributes
+    #################################################
+    __name: str = "ForexPython_DataProvider"
+    __type: str = "DataProvider"
+
+    #################################################
+    # Constructor
+    #################################################
+    def __init__(
+        self,
+        instance_id: Optional[int] = None,
+        logger: Optional[logging.Logger] = None,
+        log_level: Optional[int] = logging.INFO,
+        **config,
+    ) -> None:
+        """
+        Initialize the data provider.
+
+        :param instance_id: Unique identifier for this provider instance.
+        :param logger: Logger instance for logging operations.
+        :param log_level: Logging level for the provider.
+        :param config: Additional configuration parameters.
+        """
+        # Initialize the base DataModule
+        super().__init__(
+            instance_id=instance_id,
+            logger=logger,
+            log_level=log_level,
+            **config
+        )
+        
+        # Connect to the data source
+        self.connect()
+    
+    #################################################
+    # Connection Methods
+    #################################################
+    def _connect(self) -> None:
+        """
+        Connect to the data source.
+        """
+        self.set_connection(
+            {
+                "currency_codes": CurrencyCodes(),
+                "currency_rates": CurrencyRates(),
+                "btc_converter": BtcConverter(),
+            }
+        )
+    
+    def _disconnect(self) -> None:
+        """
+        Disconnect from the data source.
+        """
+        self.set_connection(None)
+
+    #################################################
+    # Core Instance Methods
+    #################################################
+    def get_exchange_rate_on_spot(
+        self, 
+        base_currency: str, 
+        target_currency: str, 
+        fx_datetime: Optional[Union[datetime.datetime, datetime.date]] = None,
+        *args,
+        **kwargs,
+    ) -> float:
+        """
+        Get the exchange rate for a given currency pair on the current date.
+        
+        :param base_currency: The base currency code (e.g., 'USD').
+        :param target_currency: The target currency code (e.g., 'EUR').
+        :param fx_datetime: The timestamp for the exchange rate. (could be datetime or date)
+        :param args: Additional positional arguments.
+        :param kwargs: Additional keyword arguments.
+        :return: The exchange rate as a float.
+        """
+        # Get the connection
+        currency_rates = self.get_connection().get("currency_rates")
+        
+        # Get the exchange rate
+        return currency_rates.get_rate(base_cur=base_currency, dest_cur=target_currency, date_obj=fx_datetime)
+    
+    def get_exchange_rates_historical(
+        self,
+        base_currency: str, 
+        target_currencies: List[str], 
+        fx_datetime_start: Union[datetime.datetime, datetime.date],
+        fx_datetime_end: Union[datetime.datetime, datetime.date],
+        *args,
+        **kwargs,
+    ) -> Dict[datetime.date, Dict[str, Optional[float]]]:
+        """
+        Get the exchange rates for a given currency pair on the current date.
+        
+        :param base_currency: The base currency code (e.g., 'USD').
+        :param target_currencies: The target currency codes (e.g., ['EUR', 'GBP']).
+        :param fx_datetime_start: The start timestamp for the exchange rate. (could be datetime or date)
+        :param fx_datetime_end: The end timestamp for the exchange rate. (could be datetime or date)
+        :param args: Additional positional arguments.
+        :param kwargs: Additional keyword arguments.
+        :return: The exchange rates as a dictionary.
+        """
+        # Initialize the exchange rates container
+        exchange_rates = {}
+
+        # Get the connection
+        currency_rates = self.get_connection().get("currency_rates")
+
+        # Iterate through the date list and get the exchange rates for each date
+        date_list = populate_dates_in_between(start_date=fx_datetime_start, end_date=fx_datetime_end, interval=1)
+        for date in date_list:
+            raw_record = currency_rates.get_rates(base_cur=base_currency, date_obj=date)
+            exchange_rate_record = {
+                f"{base_currency}/{target_currency}": raw_record.get(target_currency, None)
+                for target_currency in target_currencies
+            }
+            exchange_rates[date] = exchange_rate_record
+        
+        return exchange_rates
+        

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval/model/__init__.py

@@ -4,8 +4,9 @@
 # Description: Model Package Initialization
 # Author: AbigailWilliams1692
 # Created: 2026-01-14
-# Updated: 2026-01-18
+# Updated: 2026-01-24
 #######################################################################
 
 from data_retrieval.model.data_module import DataModule
 from data_retrieval.model.data_provider import DataProvider
+from data_retrieval.model.data_provider_wrapper import DataProvider_Wrapper

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval/model/data_provider.py

@@ -77,7 +77,6 @@ class DataProvider(DataModule):
         :param instance_id: Unique identifier for this provider instance.
         :param logger: Logger instance for logging operations.
         :param log_level: Logging level for the provider.
-        :param data_methods: Dictionary of data retrieval methods.
         :param config: Additional configuration parameters.
         """
         # Initialize the base DataModule

data_retrieval_module-1.0.1/data_retrieval/model/data_provider_wrapper.py

@@ -0,0 +1,428 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: data_provider_wrapper.py
+# Description: Wrapper class for managing multiple data providers
+# Author: AbigailWilliams1692
+# Created: 2026-01-24
+# Updated: 2026-01-24
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import logging
+from typing import (
+    Any,
+    Optional,
+    Dict,
+    List,
+    Type,
+)
+
+# Local Packages
+from data_retrieval.model.data_module import DataModule
+from data_retrieval.model.data_provider import DataProvider
+from data_retrieval.model.exceptions import (
+    DataProviderError,
+    DataProviderNotFoundError,
+    DataProviderInitializationError,
+    DataProviderWrapperConnectionError,
+)
+
+
+#######################################################################
+# Data Provider Wrapper Connection Status
+#######################################################################
+class DataProviderWrapperConnectionStatus:
+    """
+    Connection status for DataProvider_Wrapper.
+    """
+    CONNECTED = "connected"
+    DISCONNECTED = "disconnected"
+
+
+#######################################################################
+# Data Provider Wrapper Class
+#######################################################################
+class DataProvider_Wrapper(DataModule):
+    """
+    Wrapper class for managing multiple data providers with a unified interface.
+
+    This class allows switching between different data providers (data sources)
+    for fetching the same category of data. It mimics the DataProvider interface
+    while providing the flexibility to choose which underlying provider to use.
+    """
+
+    #################################################
+    # Class Attributes
+    #################################################
+    __name: str = "DataProvider_Wrapper"
+    __type: str = "DataProvider_Wrapper"
+
+    #################################################
+    # Constructor
+    #################################################
+    def __init__(
+        self,
+        data_source: str,
+        instance_id: Optional[int] = None,
+        logger: Optional[logging.Logger] = None,
+        log_level: Optional[int] = logging.INFO,
+        valid_data_sources: Optional[List[str]] = None,
+        valid_data_source_mapping: Optional[Dict[str, Type[DataProvider]]] = None,
+        **config,
+    ) -> None:
+        """
+        Initialize the data provider wrapper.
+
+        :param data_source: The data source name to use for fetching data.
+        :param instance_id: Unique identifier for this wrapper instance.
+        :param logger: Logger instance for logging operations.
+        :param log_level: Logging level for the wrapper.
+        :param config: Additional configuration parameters.
+        """
+        # Initialize the base DataModule
+        super().__init__(
+            instance_id=instance_id,
+            logger=logger,
+            log_level=log_level,
+        )
+
+        # Initialize DataProvider_Wrapper attributes
+        ## Valid data sources and mappings
+        self.__valid_data_sources = valid_data_sources
+        self.__valid_data_source_mapping = valid_data_source_mapping
+
+        ## Other attributes
+        self._config = config or {}
+        self._data_source: Optional[str] = data_source
+        self._data_provider: Optional[DataProvider] = self._initialize_data_provider_instance(data_source=data_source)
+
+        # Set initial status for the DataProvider_Wrapper instance
+        self.set_status(DataProviderWrapperConnectionStatus.DISCONNECTED)
+
+    #################################################
+    # Getter & Setter Methods
+    #################################################
+    def get_valid_data_sources(self) -> List[str]:
+        """
+        Get the list of valid data sources.
+
+        :return: The list of valid data sources.
+        """
+        return self.__valid_data_sources
+
+    def set_valid_data_sources(self, valid_data_sources: List[str]) -> None:
+        """
+        Set the list of valid data sources.
+
+        :param valid_data_sources: The list of valid data sources to set.
+        :return: None.
+        """
+        self.__valid_data_sources = valid_data_sources
+
+    def add_valid_data_source(self, valid_data_source: str) -> None:
+        """
+        Add a valid data source to the list of valid data sources.
+
+        :param valid_data_source: The valid data source to add.
+        :return: None.
+        """
+        self.__valid_data_sources.append(valid_data_source)
+
+    def remove_valid_data_source(self, valid_data_source: str) -> None:
+        """
+        Remove a valid data source from the list of valid data sources.
+
+        :param valid_data_source: The valid data source to remove.
+        :return: None.
+        """
+        self.__valid_data_sources.remove(valid_data_source)
+
+    def get_valid_data_source_mapping(self) -> Dict[str, Type[DataProvider]]:
+        """
+        Get the mapping of valid data sources to their corresponding DataProvider classes.
+
+        :return: The mapping of valid data sources to their corresponding DataProvider classes.
+        """
+        return self.__valid_data_source_mapping
+
+    def set_valid_data_source_mapping(self, valid_data_source_mapping: Dict[str, Type[DataProvider]]) -> None:
+        """
+        Set the mapping of valid data sources to their corresponding DataProvider classes.
+
+        :param valid_data_source_mapping: The mapping of valid data sources to their corresponding DataProvider classes.
+        :return: None.
+        """
+        self.__valid_data_source_mapping = valid_data_source_mapping
+
+    def update_valid_data_source_mapping(self, valid_data_source: str, data_provider_class: Type[DataProvider]) -> None:
+        """
+        Update the mapping of a valid data source to its corresponding DataProvider class.
+
+        :param valid_data_source: The valid data source to update.
+        :param data_provider_class: The DataProvider class to map to the valid data source.
+        :return: None.
+        """
+        self.__valid_data_source_mapping[valid_data_source] = data_provider_class
+
+    def get_config(self) -> Dict[str, Any]:
+        """
+        Get the configuration dictionary.
+
+        :return: The configuration dictionary.
+        """
+        return self._config
+
+    def set_config(self, config: Dict[str, Any]) -> None:
+        """
+        Set the configuration dictionary.
+
+        :param config: The configuration dictionary.
+        :return: None.
+        """
+        self._config = config
+
+    def update_config(self, key: str, value: Any) -> None:
+        """
+        Update a specific configuration key-value pair.
+
+        :param key: The configuration key to update.
+        :param value: The new value for the configuration key.
+        :return: None.
+        """
+        self._config.update({key: value})
+
+    def get_data_source(self) -> Optional[str]:
+        """
+        Get the current data source.
+
+        :return: The current data source name.
+        """
+        return self._data_source
+
+    def set_data_source(self, data_source: str) -> None:
+        """
+        Validate the data source first and set the data source to use for fetching data.
+
+        :param data_source: The name of the data source to use.
+        :return: None.
+        :raises KeyError: If the data source is not registered.
+        """
+        if not self.validate_data_source(data_source):
+            raise KeyError(f"Data source '{data_source}' is not valid.")
+        self._data_source = data_source
+
+    def get_data_provider(self) -> Optional[DataProvider]:
+        """
+        Get the current data provider.
+
+        :return: The current data provider instance.
+        """
+        return self._data_provider
+
+    def set_data_provider(self, data_provider: DataProvider) -> None:
+        """
+        Set the current data provider.
+
+        :param data_provider: The DataProvider instance to set.
+        :return: None.
+        """
+        self._data_provider = data_provider
+
+    #################################################
+    # Data Provider Management Methods
+    #################################################
+    def switch_data_provider(self, data_source: str) -> None:
+        """
+        Switch to another data provider that has already been registered.
+
+        :param data_source: The data source name to register.
+        :return: None.
+        """
+        if data_source == self.get_data_source():
+            raise ValueError(f"Data source '{data_source}' is already the current data source.")
+        elif self.validate_data_source(data_source=data_source):
+            self.set_data_source(data_source=data_source)
+            self.set_data_provider(
+                data_provider=self._initialize_data_provider_instance(data_source=data_source)
+            )
+
+    def register_data_provider(self, data_source: str, data_provider_class: Type[DataProvider]) -> None:
+        """
+        Register a new data provider class.
+
+        :param data_source: The data source name to register.
+        :param data_provider_class: The DataProvider class to register.
+        :return: None.
+        """
+        self.__valid_data_sources[data_source] = data_provider_class
+
+    def unregister_data_provider(self, data_source: str) -> None:
+        """
+        Unregister a data provider class.
+
+        :param data_source: The data source name to unregister.
+        :return: None.
+        """
+        if data_source in self.__valid_data_sources:
+            del self.__valid_data_sources[data_source]
+
+    def _initialize_data_provider_instance(self, data_source: Optional[str] = None) -> DataProvider:
+        """
+        Initialize the data provider as the data source instance.
+
+        :param data_source: The data source to use. If None, uses the current data source.
+        :return: The initialized data provider instance.
+        """
+        # Check if data source is None.
+        if data_source is None:
+            data_source = self.get_data_source()
+
+        # Get the data provider class from the mapping
+        data_provider_class = self.__valid_data_source_mapping.get(data_source, None)
+        
+        # Check if the data provider class is found
+        if data_provider_class is None:
+            raise DataProviderNotFoundError(
+                f"No data provider found for data source: '{data_source}'."
+            )
+
+        # Initialize the data provider instance
+        try:
+            data_provider_instance = data_provider_class(
+                log_level=self.get_log_level(),
+                **self.get_config(),
+            )
+        except DataProviderError as e:
+            raise e
+        except Exception as e:
+            raise DataProviderInitializationError(
+                f"Failed to initialize data provider for data source: '{data_source}'. Error: {str(e)}"
+            )
+
+        return data_provider_instance
+            
+    #################################################
+    # Connection Methods
+    #################################################
+    def is_connected(self) -> bool:
+        """
+        Check if the specified data provider is connected.
+
+        :return: True if connected, False otherwise.
+        """
+        data_provider = self.get_data_provider()
+        if data_provider is None:
+            raise DataProviderNotFoundError(
+                f"No data provider found for data source: '{self.get_data_source()}'."
+            )
+        return data_provider.is_connected()
+
+    def connect(self) -> None:
+        """
+        Connect to the specified data provider.
+        """
+        try:
+            data_provider = self.get_data_provider()
+            if data_provider is None:
+                raise DataProviderNotFoundError(
+                    f"No data provider found for data source: '{self.get_data_source()}'."
+                )
+            data_provider.connect()
+            self.set_status(DataProviderWrapperConnectionStatus.CONNECTED)
+        except DataProviderError as e:
+            raise e
+        except Exception as e:
+            raise DataProviderWrapperConnectionError(
+                f"Failed to connect to data provider for data source: '{self.get_data_source()}'. Error: {str(e)}"
+            )
+
+    def disconnect(self) -> None:
+        """
+        Disconnect from the specified data provider.
+        """
+        try:
+            data_provider = self.get_data_provider()
+            if data_provider is None:
+                raise DataProviderNotFoundError(
+                    f"No data provider found for data source: '{self.get_data_source()}'."
+                )
+            data_provider.disconnect()
+            self.set_status(DataProviderWrapperConnectionStatus.DISCONNECTED)
+        except DataProviderError as e:
+            raise e
+        except Exception as e:
+            raise DataProviderWrapperConnectionError(
+                f"Failed to disconnect from data provider for data source: '{self.get_data_source()}'. Error: {str(e)}"
+            )
+
+    #################################################
+    # Context Management
+    #################################################
+    def __enter__(self) -> "DataProvider":
+        """
+        Enter the runtime context related to this object. Automatically connects to the data source.
+        """
+        return self
+    
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        """
+        Exit the runtime context related to this object. Automatically disconnects from the data source.
+        """
+        self.disconnect()
+
+    #################################################
+    # Core Instance Method: Fetch Data
+    #################################################
+    def fetch_data(
+        self,
+        data_point: str,
+        return_data_type: type,
+        *args,
+        **kwargs,
+    ) -> Any:
+        """
+        Fetch data from the specified data source.
+ 
+        :param data_point: The data point to fetch.
+        :param return_data_type: The expected return data type.
+        :param args: Positional arguments for fetching data.
+        :param kwargs: Keyword arguments for fetching data.
+        :return: The fetched data.
+        :raises DataProviderNotFoundError: If no provider is found for the data source.
+        :raises DataMethodNotFoundError: If the data method is not found.
+        :raises ReturnDataTypeNotMatchedError: If the return data type does not match.
+        """
+        # Get the data provider for the current data source
+        data_provider = self.get_data_provider()
+
+        # Check if the data provider exists
+        if data_provider is None:
+            raise DataProviderNotFoundError(
+                f"No data provider found for data source '{self.get_data_source()}'."
+            )
+
+        # Fetch the data
+        data: Any = data_provider.fetch_data(
+            data_point=data_point, 
+            return_data_type=return_data_type, 
+            *args, 
+            **kwargs
+        )
+        
+        return data
+
+    #################################################
+    # Utility Methods
+    #################################################
+    def validate_data_source(self, data_source: str) -> bool:
+        """
+        Validate if the provided data source is supported.
+        
+        :param data_source: The data source to validate.
+        :return: True if the data source is valid, False otherwise.
+        """
+        print(self.get_valid_data_sources())
+        return data_source in self.__valid_data_sources

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval/model/exceptions.py

@@ -4,17 +4,22 @@
 # Description: Exception classes for data providers
 # Author: AbigailWilliams1692
 # Created: 2026-01-14
-# Updated: 2026-01-19
+# Updated: 2026-01-24
 #######################################################################
 
 #######################################################################
-# Exception Classes
+# Data Provider Exceptions
 #######################################################################
 class DataProviderError(Exception):
     """Base exception for data provider errors."""
     pass
 
 
+class DataProviderInitializationError(DataProviderError):
+    """Raised when initialization of data provider fails."""
+    pass
+
+
 class DataProviderConnectionError(DataProviderError):
     """Raised when connection to data source fails."""
     pass
@@ -36,3 +41,19 @@ class ReturnDataTypeNotMatchedError(DataProviderError):
 class ValidationError(DataProviderError):
     """Raised when data validation fails."""
     pass
+
+
+#######################################################################
+# Data Provider Wrapper Exceptions
+#######################################################################
+class DataProviderWrapperError(Exception):
+    """Base exception for data provider wrapper errors."""
+    pass
+
+class DataProviderNotFoundError(DataProviderWrapperError):
+    """Raised when cannot find the corresponding data provider class."""
+    pass
+
+class DataProviderWrapperConnectionError(DataProviderWrapperError):
+    """Raised when connection to data provider fails."""
+    pass

data_retrieval_module-1.0.1/data_retrieval/utils/date_utils.py

@@ -0,0 +1,54 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: date_utils.py
+# Description: Util functions for date operations
+# Author: AbigailWilliams1692
+# Created: 2026-01-24
+# Updated: 2026-01-24
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import datetime
+from typing import List, Tuple
+
+
+#######################################################################
+# Util Functions
+#######################################################################
+def populate_dates_in_between(
+    start_date: datetime.date, 
+    end_date: datetime.date, 
+    interval: int = 1
+) -> List[datetime.date]:
+    """
+    Populate a list of dates between start_date and end_date (inclusive).
+    
+    :param start_date: The start date.
+    :param end_date: The end date.
+    :param interval: The interval between dates in days.
+    :return: List of dates between start_date and end_date.
+    """
+    if start_date > end_date:
+        raise ValueError("start_date must be before or equal to end_date")
+    delta = end_date - start_date
+    return [start_date + datetime.timedelta(days=i) for i in range(0, delta.days + 1, interval)]
+
+
+def populate_start_and_end_dates(
+    start_date: datetime.date, 
+    end_date: datetime.date, 
+    interval: int = 1
+) -> List[Tuple[datetime.date, datetime.date]]:
+    """
+    Populate a list of dates between start_date and end_date (inclusive).
+    
+    :param start_date: The start date.
+    :param end_date: The end date.
+    :param interval: The interval between dates in days.
+    :return: List of start date and end date tuples.
+    """
+    date_list = populate_dates_in_between(start_date=start_date, end_date=end_date, interval=interval)
+    return [(date_list[i], date_list[i+1]) for i in range(0, len(date_list)-1)]

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval_module.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-retrieval-module
-Version: 1.0.0
+Version: 1.0.1
 Summary: A standardized interface for data providers with sync and async support
 Author-email: AbigailWilliams1692 <abigail.williams@example.com>
 Maintainer-email: AbigailWilliams1692 <abigail.williams@example.com>
@@ -28,6 +28,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typing-extensions>=4.0.0; python_version < "3.10"
+Requires-Dist: forex-python>=1.0.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval_module.egg-info/SOURCES.txt

@@ -8,10 +8,17 @@ requirements-test.txt
 setup.py
 data_retrieval/__init__.py
 data_retrieval/py.typed
+data_retrieval/foreign_exchange/__init__.py
+data_retrieval/foreign_exchange/forex_data_provider_base.py
+data_retrieval/foreign_exchange/forex_data_provider_wrapper.py
+data_retrieval/foreign_exchange/forex_python_data_provider.py
 data_retrieval/model/__init__.py
 data_retrieval/model/data_module.py
 data_retrieval/model/data_provider.py
+data_retrieval/model/data_provider_wrapper.py
 data_retrieval/model/exceptions.py
+data_retrieval/utils/__init__.py
+data_retrieval/utils/date_utils.py
 data_retrieval_module.egg-info/PKG-INFO
 data_retrieval_module.egg-info/SOURCES.txt
 data_retrieval_module.egg-info/dependency_links.txt

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/data_retrieval_module.egg-info/requires.txt

@@ -1,3 +1,4 @@
+forex-python>=1.0.0
 
 [:python_version < "3.10"]
 typing-extensions>=4.0.0

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "data-retrieval-module"
-version = "1.0.0"
+version = "1.0.1"
 description = "A standardized interface for data providers with sync and async support"
 readme = "README.md"
 license = "MIT"
@@ -33,6 +33,7 @@ classifiers = [
 requires-python = ">=3.8"
 dependencies = [
     "typing-extensions>=4.0.0; python_version<'3.10'",
+    "forex-python>=1.0.0",
 ]
 
 [project.optional-dependencies]
@@ -79,7 +80,7 @@ Repository = "https://github.com/AbigailWilliams1692/data-retrieval-module"
 Changelog = "https://github.com/AbigailWilliams1692/data-retrieval-module/blob/main/CHANGELOG.md"
 
 [tool.setuptools]
-packages = ["data_retrieval", "data_retrieval.model"]
+packages = ["data_retrieval", "data_retrieval.model", "data_retrieval.foreign_exchange", "data_retrieval.utils"]
 
 [tool.setuptools.package-data]
 data_retrieval = ["py.typed"]

{data_retrieval_module-1.0.0 → data_retrieval_module-1.0.1}/tests/test_basic.py

@@ -26,7 +26,7 @@ def test_version():
     import data_retrieval
     
     assert hasattr(data_retrieval, '__version__')
-    assert data_retrieval.__version__ == "1.0.0"
+    assert data_retrieval.__version__ == "1.0.1"
 
 # Test package structure
 def test_package_structure():