data-retrieval-module 1.0.0__py3-none-any.whl

data_retrieval/__init__.py

@@ -0,0 +1,61 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: __init__.py
+# Description: Data Retrieval Module package initialization
+# Author: AbigailWilliams1692
+# Created: 2026-01-14
+# Updated: 2026-01-18
+#######################################################################
+
+#######################################################################
+# Import Core Classes
+#######################################################################
+from data_retrieval.model.data_provider import DataProvider
+from data_retrieval.model.data_module import DataModule
+from data_retrieval.model.exceptions import (
+    DataProviderError,
+    DataProviderConnectionError,
+    DataFetchError,
+    DataMethodNotFoundError,
+    ReturnDataTypeNotMatchedError,
+    ValidationError
+)
+
+#######################################################################
+# Import Data Provider Implementations
+#######################################################################
+# REST API providers
+from data_retrieval.data_provider.rest_api import RestAPI_DataProvider
+
+# Database providers
+from data_retrieval.data_provider.database import Database_DataProvider
+
+#######################################################################
+# Public API
+#######################################################################
+__all__ = [
+    # Core classes
+    "DataProvider",
+    "DataModule",
+    
+    # Exceptions
+    "DataProviderError",
+    "DataProviderConnectionError",
+    "DataFetchError",
+    "DataMethodNotFoundError",
+    "ReturnDataTypeNotMatchedError",
+    "ValidationError",
+    
+    # REST API providers
+    "RestAPI_DataProvider",
+    
+    # Database providers
+    "Database_DataProvider",
+]
+
+#######################################################################
+# Version Information
+#######################################################################
+__version__ = "1.0.0"
+__author__ = "AbigailWilliams1692"
+__email__ = "abigail.williams@example.com"

data_retrieval/model/__init__.py

@@ -0,0 +1,11 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: __init__.py
+# Description: Model Package Initialization
+# Author: AbigailWilliams1692
+# Created: 2026-01-14
+# Updated: 2026-01-18
+#######################################################################
+
+from data_retrieval.model.data_module import DataModule
+from data_retrieval.model.data_provider import DataProvider

data_retrieval/model/data_module.py

@@ -0,0 +1,150 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: data_module.py
+# Description: Abstract base class for aall data modules
+# Author: AbigailWilliams1692
+# Created: 2025-11-13
+# Updated: 2026-01-19
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import logging
+from abc import ABC
+from typing import Any, Optional
+
+# Local Packages
+
+
+#################################################
+# Class Definition
+#################################################
+class DataModule(ABC):
+    """
+    Data Module Abstract Base Class. Provides the interface for all data modules.
+    """
+
+    #################################################
+    # Class Attributes
+    #################################################
+    __name: str = "BaseDataModule"
+    __type: str = "DataModule"
+
+    #################################################
+    # Constructor
+    #################################################
+    def __init__(
+        self,
+        instance_id: Optional[int] = None,
+        logger: Optional[logging.Logger] = None,
+        log_level: Optional[int] = logging.INFO,
+    ) -> None:
+        """
+        Constructor method.
+
+        :param instance_id: str: Unique identifier for the data module instance.
+        :param logger: logging.Logger: Logger instance for logging.
+        """
+        # DataProvider ID
+        self._instance_id = instance_id or id(self)
+
+        # Log Level
+        self._log_level = log_level
+
+        # Logger
+        self._logger = logger or self.refresh_logger()
+
+        # Status
+        self._status = None
+
+    #################################################
+    # Getter & Setter Methods
+    #################################################
+    def get_name(self) -> str:
+        """
+        Get the name of the data module.
+
+        :return: str: Name of the data module.
+        """
+        return self.__name
+
+    def get_type(self) -> str:
+        """
+        Get the type of the data module.
+
+        :return: str: Type of the data module.
+        """
+        return self.__type
+
+    def get_instance_id(self) -> str:
+        """
+        Get the unique identifier of the data module instance.
+
+        :return: str: Unique identifier of the data module instance.
+        """
+        return self._instance_id
+
+    def set_instance_id(self, instance_id: str) -> None:
+        """
+        Set the unique identifier of the data module instance.
+
+        :param instance_id: str: Unique identifier of the data module instance.
+        """
+        self._instance_id = instance_id
+
+    def get_logger(self) -> logging.Logger:
+        """
+        Get the logger instance.
+
+        :return: logging.Logger: Logger instance.
+        """
+        return self._logger
+
+    def set_logger(self, logger: logging.Logger) -> None:
+        """
+        Set the logger instance.
+
+        :param logger: logging.Logger: Logger instance.
+        """
+        self._logger = logger
+
+    def refresh_logger(self) -> logging.Logger:
+        """
+        Refresh the logger instance.
+        """
+        logger = logging.getLogger(name=self.__class__.__name__)
+        logger.setLevel(self._log_level)
+        return logger
+
+    def get_log_level(self) -> int:
+        """
+        Get the log level of the logger instance.
+
+        :return: int: Log level of the logger instance.
+        """
+        return self._log_level
+    
+    def set_log_level(self, log_level: int) -> None:
+        """
+        Set the log level of the logger instance.
+
+        :param log_level: int: Log level of the logger instance.
+        """
+        self._logger.setLevel(level=log_level)
+
+    def get_status(self) -> Any:
+        """Get the preoccupation status of the data module.
+
+        :return: Any: Preoccupation status of the data module.
+        """
+        return self._status
+
+    def set_status(self, status: Any) -> None:
+        """
+        Set the preoccupation status of the data module.
+
+        :param status: Any: Preoccupation status of the data module.
+        """
+        self._status = status

data_retrieval/model/data_provider.py

@@ -0,0 +1,313 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: data_provider.py
+# Description: Abstract base class for data providers
+# Author: AbigailWilliams1692
+# Created: 2025-11-13
+# Updated: 2026-01-18
+#######################################################################
+
+#######################################################################
+# Import Packages
+#######################################################################
+# Standard Packages
+import logging
+from abc import abstractmethod
+from collections.abc import Callable
+from enum import Enum
+from typing import (
+    Any,
+    Optional,
+    Dict,
+    Callable,
+)
+
+# Local Packages
+from data_retrieval.model.data_module import DataModule
+from data_retrieval.model.exceptions import (
+    DataProviderConnectionError,
+    DataMethodNotFoundError,
+    ReturnDataTypeNotMatchedError,
+)
+
+
+#######################################################################
+# Enums & Data Classes
+#######################################################################
+class DataProviderConnectionStatus(Enum):
+    """
+    Enumeration of provider connection states.
+    """
+    DISCONNECTED = "disconnected"
+    CONNECTED = "connected"
+    ERROR = "error"
+
+
+#######################################################################
+# Data Provider Class
+#######################################################################
+class DataProvider(DataModule):
+    """
+    Abstract base class for data providers with standardized synchronous API interface.
+
+    This class provides a unified interface for retrieving data from various sources
+    (APIs, databases, files, etc.). Subclasses must implement the abstract methods
+    to provide source-specific data retrieval logic.
+    """
+
+    #################################################
+    # Class Attributes
+    #################################################
+    __name: str = "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 data_methods: Dictionary of data retrieval methods.
+        :param config: Additional configuration parameters.
+        """
+        # Initialize the base DataModule
+        super().__init__(
+            instance_id=instance_id,
+            logger=logger,
+            log_level=log_level,
+        )
+
+        # Intialize DataProvider attributes
+        self._config = config or {}
+        self._connection = None
+        self._data_methods = {}
+        
+        # Set initial status for the DataProvider instance
+        self.set_status(DataProviderConnectionStatus.DISCONNECTED)
+
+    #################################################
+    # Getter & Setter Methods
+    #################################################
+    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_connection(self) -> Any:
+        """
+        Get the connection object.
+
+        :return: The connection object.
+        """
+        return self._connection
+
+    def set_connection(self, connection: Any) -> None:
+        """
+        Set the connection object.
+
+        :param connection: The connection object.
+        :return: None.
+        """
+        self._connection = connection
+
+    def get_data_methods(self) -> Dict[str, Any]:
+        """
+        Get the data methods dictionary.
+
+        :return: The data methods dictionary.
+        """
+        return self._data_methods
+
+    def get_data_method(self, data_point: str) -> Optional[Callable]:
+        """
+        Get a data method from the data methods dictionary.
+
+        :param data_point: The name of the data method.
+        :return: The data method.
+        """
+        return self._data_methods.get(data_point)
+
+    def update_data_methods(self, new_methods: Dict[str, Callable]) -> None:
+        """
+        Update the data methods with new methods, merging with existing ones.
+        
+        :param new_methods: Dictionary of new data methods to add/update.
+        :return: None.
+        """
+        self._data_methods.update(new_methods)
+
+    def set_data_methods(self, data_methods: Dict[str, Any]) -> None:
+        """
+        Set the data methods dictionary.
+
+        :param data_methods: The data methods dictionary.
+        :return: None.
+        """
+        self._data_methods = data_methods
+
+    def add_data_method(self, data_point: str, method: Any) -> None:
+        """
+        Add a data method to the data methods dictionary.
+
+        :param data_point: The name of the data method.
+        :param method: The data method.
+        :return: None.
+        """
+        self._data_methods.update(
+            {
+                data_point: method,
+            }
+        )
+
+    def delete_data_method(self, data_point: str) -> None:
+        """
+        Delete a data method from the data methods dictionary.
+
+        :param data_point: The name of the data method to delete.
+        :return: None.
+        """
+        if data_point in self._data_methods:
+            del self._data_methods[data_point]
+    
+    #################################################
+    # Connection Methods
+    #################################################
+    def is_connected(self) -> bool:
+        """
+        Check if the data provider is connected to the data source.
+
+        :return: True if connected, False otherwise.
+        """
+        return self._connection is not None
+
+    def connect(self, *args, **kwargs) -> None:
+        """
+        Safely Connect to the data source.
+
+        :param args: Positional arguments for connection.
+        :param kwargs: Keyword arguments for connection.
+        :return: None.
+        :raise ConnectionError: If connection fails.
+        """
+        try:
+            self._connect(*args, **kwargs)
+            self.set_status(status=DataProviderConnectionStatus.CONNECTED)
+        except Exception as e:
+            raise DataProviderConnectionError(f"Failed to connect to data source: {e}")
+
+    @abstractmethod
+    def _connect(self, *args, **kwargs):
+        """
+        Abstract method to connect to the data source.
+        """
+        raise NotImplementedError("Subclasses must implement this method")
+
+    def disconnect(self, *args, **kwargs) -> None:
+        """
+        Safely disconnect from the data source.
+
+        :param args: Positional arguments for connection.
+        :param kwargs: Keyword arguments for connection.
+        :return: None.
+        :raise ConnectionError: If connection fails.
+        """
+        try:
+            self._disconnect(*args, **kwargs)
+            self.set_status(status=DataProviderConnectionStatus.DISCONNECTED)
+        except Exception as e:
+            raise DataProviderConnectionError(f"Failed to disconnect from data source: {e}")
+
+    @abstractmethod
+    def _disconnect(self, *args, **kwargs):
+        """
+        Abstract method to disconnect from the data source.
+        """
+        raise NotImplementedError("Subclasses must implement this method")
+            
+    def refresh_connection(self, *args, **kwargs) -> None:
+        """
+        Refresh the connection.
+
+        :param args: Positional arguments for connection.
+        :param kwargs: Keyword arguments for connection.
+        :return: None.
+        :raise ConnectionError: If connection fails.
+        """
+        self.disconnect(*args, **kwargs)
+        self.connect(*args, **kwargs)
+
+    
+    #################################################
+    # 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:
+        """
+        Base method to fetch data based on the data point and return type.
+
+        :param data_point: str: The data point to fetch.
+        :param return_data_type: type: The type of data to return.
+        :param args: Tuple: Positional arguments for fetching data.
+        :param kwargs: Dict: Keyword arguments for fetching data.
+        :return: The fetched data.
+        """
+        # Extract the corresponding data method
+        data_method = self.get_data_method(data_point=data_point)
+        if data_method is None:
+            raise DataMethodNotFoundError(f"Data method for data point '{data_point}' not found.")
+        
+        # Retrieve the data
+        data = data_method(*args, **kwargs)
+
+        # Check the return data type
+        if not isinstance(data, return_data_type):
+            raise ReturnDataTypeNotMatchedError(f"Data type mismatch. Expected {return_data_type}, got {type(data)}.")
+        
+        return data
+

data_retrieval/model/exceptions.py

@@ -0,0 +1,38 @@
+#######################################################################
+# Project: Data Retrieval Module
+# File: exceptions.py
+# Description: Exception classes for data providers
+# Author: AbigailWilliams1692
+# Created: 2026-01-14
+# Updated: 2026-01-19
+#######################################################################
+
+#######################################################################
+# Exception Classes
+#######################################################################
+class DataProviderError(Exception):
+    """Base exception for data provider errors."""
+    pass
+
+
+class DataProviderConnectionError(DataProviderError):
+    """Raised when connection to data source fails."""
+    pass
+
+
+class DataFetchError(DataProviderError):
+    """Raised when a query operation fails."""
+    pass
+
+class DataMethodNotFoundError(DataProviderError):
+    """Raised when a requested data method is not found."""
+    pass
+
+class ReturnDataTypeNotMatchedError(DataProviderError):
+    """Raised when the retrieved data type does not match the expected type."""
+    pass
+
+
+class ValidationError(DataProviderError):
+    """Raised when data validation fails."""
+    pass

data_retrieval/py.typed

@@ -0,0 +1,2 @@
+# This file indicates that the data_retrieval package is a typed package
+# It enables type checkers to understand that this package contains type annotations

data_retrieval_module-1.0.0.dist-info/METADATA

@@ -0,0 +1,350 @@
+Metadata-Version: 2.4
+Name: data-retrieval-module
+Version: 1.0.0
+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>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/AbigailWilliams1692/data-retrieval-module
+Project-URL: Documentation, https://github.com/AbigailWilliams1692/data-retrieval-module/wiki
+Project-URL: Repository, https://github.com/AbigailWilliams1692/data-retrieval-module
+Project-URL: Bug Tracker, https://github.com/AbigailWilliams1692/data-retrieval-module/issues
+Project-URL: Changelog, https://github.com/AbigailWilliams1692/data-retrieval-module/blob/main/CHANGELOG.md
+Keywords: data,retrieval,provider,async,sync,database,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Database
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions>=4.0.0; python_version < "3.10"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Provides-Extra: async
+Requires-Dist: aiohttp>=3.8.0; extra == "async"
+Requires-Dist: aiosqlite>=0.19.0; extra == "async"
+Requires-Dist: asyncpg>=0.28.0; extra == "async"
+Provides-Extra: database
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "database"
+Requires-Dist: PyMySQL>=1.0.0; extra == "database"
+Provides-Extra: all
+Requires-Dist: pytest>=7.0.0; extra == "all"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "all"
+Requires-Dist: pytest-cov>=4.0.0; extra == "all"
+Requires-Dist: pytest-mock>=3.10.0; extra == "all"
+Requires-Dist: black>=23.0.0; extra == "all"
+Requires-Dist: flake8>=6.0.0; extra == "all"
+Requires-Dist: mypy>=1.0.0; extra == "all"
+Requires-Dist: isort>=5.12.0; extra == "all"
+Requires-Dist: aiohttp>=3.8.0; extra == "all"
+Requires-Dist: aiosqlite>=0.19.0; extra == "all"
+Requires-Dist: asyncpg>=0.28.0; extra == "all"
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "all"
+Requires-Dist: PyMySQL>=1.0.0; extra == "all"
+Dynamic: license-file
+
+# Data Retrieval Module
+
+A standardized interface for data providers with both synchronous and asynchronous support. This module provides abstract base classes that enable consistent data retrieval patterns across different data sources (APIs, databases, files, etc.).
+
+## Features
+
+- 🔄 **Dual API Support**: Both sync and async interfaces
+- 🏗️ **Abstract Base Classes**: Standardized patterns for data providers
+- 🔌 **Connection Management**: Built-in connection handling with context managers
+- 🔄 **Retry Logic**: Automatic retry with configurable parameters
+- 📊 **Pagination Support**: Standardized pagination with QueryResult
+- 🎣 **Hook Methods**: Customizable validation and transformation
+- 🧪 **Type Safety**: Full type hints and generic support
+- ✅ **Well Tested**: Comprehensive unit test coverage
+
+## Installation
+
+### Basic Installation
+```bash
+pip install data-retrieval-module
+```
+
+### With Async Support
+```bash
+pip install data-retrieval-module[async]
+```
+
+### Development Installation
+```bash
+pip install data-retrieval-module[dev]
+```
+
+### All Features
+```bash
+pip install data-retrieval-module[all]
+```
+
+## Quick Start
+
+### Synchronous Data Provider
+
+```python
+from data_retrieval import DataProvider, QueryResult
+from data_retrieval.model import ProviderStatus
+
+class UserProvider(DataProvider[User]):
+    def _connect(self) -> None:
+        self._db = Database.connect(...)
+    
+    def _disconnect(self) -> None:
+        self._db.close()
+    
+    def fetch(self, *args, **kwargs) -> QueryResult[User]:
+        filters = kwargs.get("filters", {})
+        users = self._db.users.find(filters)
+        return QueryResult(
+            data=users,
+            total_count=len(users),
+            metadata={"source": "database"}
+        )
+
+# Usage
+provider = UserProvider()
+with provider.connection(host="localhost", port=5432):
+    result = provider.fetch(filters={"active": True})
+    for user in result.data:
+        print(user.name)
+```
+
+### Asynchronous Data Provider
+
+```python
+from data_retrieval import AsyncDataProvider
+
+class AsyncUserProvider(AsyncDataProvider[User]):
+    async def _connect(self) -> None:
+        self._db = await Database.connect(...)
+    
+    async def _disconnect(self) -> None:
+        await self._db.close()
+    
+    async def fetch(self, *args, **kwargs) -> QueryResult[User]:
+        filters = kwargs.get("filters", {})
+        users = await self._db.users.find(filters)
+        return QueryResult(
+            data=users,
+            total_count=len(users),
+            metadata={"source": "database"}
+        )
+
+# Usage
+async def main():
+    provider = AsyncUserProvider()
+    async with provider.async_connection(host="localhost", port=5432) as p:
+        result = await p.fetch(filters={"active": True})
+        for user in result.data:
+            print(user.name)
+```
+
+## Core Classes
+
+### DataProvider (Synchronous)
+
+Abstract base class for synchronous data providers.
+
+**Key Methods:**
+- `connect(**config)` - Establish connection
+- `disconnect()` - Close connection
+- `fetch(*args, **kwargs)` - Retrieve data
+- `fetch_or_raise(*args, **kwargs)` - Fetch with error handling
+- `with_retry(operation, max_retries, retry_delay)` - Retry logic
+
+**Hook Methods:**
+- `validate(data)` - Validate data
+- `transform(data)` - Transform data
+- `health_check()` - Health status
+
+### AsyncDataProvider (Asynchronous)
+
+Abstract base class for asynchronous data providers.
+
+**Key Methods:**
+- `async connect(**config)` - Establish connection
+- `async disconnect()` - Close connection
+- `async fetch(*args, **kwargs)` - Retrieve data
+- `async fetch_or_raise(*args, **kwargs)` - Fetch with error handling
+- `async with_retry(operation, max_retries, retry_delay)` - Retry logic
+
+### QueryResult
+
+Standardized container for query results.
+
+```python
+@dataclass
+class QueryResult[T]:
+    data: List[T]
+    total_count: int
+    metadata: Dict[str, Any]
+    
+    def is_empty(self) -> bool:
+        return self.total_count == 0
+```
+
+## Advanced Usage
+
+### Custom Validation
+
+```python
+class ValidatedProvider(DataProvider[User]):
+    def validate(self, data: User) -> bool:
+        # Custom validation logic
+        return data.email and "@" in data.email
+```
+
+### Data Transformation
+
+```python
+class TransformingProvider(DataProvider[User]):
+    def transform(self, data: dict) -> User:
+        # Convert raw data to User object
+        return User(**data)
+```
+
+### Retry Logic
+
+```python
+provider = MyProvider()
+
+# Retry with custom parameters
+result = provider.with_retry(
+    operation=lambda: provider.fetch(filters={"id": "123"}),
+    max_retries=5,
+    retry_delay=2.0,
+    parameters={}
+)
+```
+
+### Context Managers
+
+```python
+# Automatic connection management
+with provider.connection(host="localhost") as p:
+    data = p.fetch()
+
+# Async version
+async with provider.async_connection(host="localhost") as p:
+    data = await p.fetch()
+```
+
+## Error Handling
+
+The module provides specific exception types:
+
+```python
+from data_retrieval.model.exceptions import (
+    DataProviderError,
+    ConnectionError,
+    QueryError,
+    ValidationError
+)
+
+try:
+    result = provider.fetch(filters={"invalid": "field"})
+except ConnectionError as e:
+    print(f"Connection failed: {e}")
+except QueryError as e:
+    print(f"Query failed: {e}")
+except DataProviderError as e:
+    print(f"General error: {e}")
+```
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone repository
+git clone https://github.com/AbigailWilliams1692/data-retrieval-module.git
+cd data-retrieval-module
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install development dependencies
+pip install -e .[dev]
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=data_retrieval --cov-report=html
+
+# Run specific test file
+pytest tests/test_data_provider.py
+```
+
+### Code Quality
+
+```bash
+# Format code
+black data_retrieval/ tests/
+
+# Sort imports
+isort data_retrieval/ tests/
+
+# Type checking
+mypy data_retrieval/
+
+# Linting
+flake8 data_retrieval/ tests/
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.
+
+## Support
+
+- 📖 [Documentation](https://github.com/AbigailWilliams1692/data-retrieval-module/wiki)
+- 🐛 [Bug Reports](https://github.com/AbigailWilliams1692/data-retrieval-module/issues)
+- 💬 [Discussions](https://github.com/AbigailWilliams1692/data-retrieval-module/discussions)
+
+## Related Projects
+
+- [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) - SQL toolkit and ORM
+- [Django ORM](https://github.com/django/django) - Django's database ORM
+- [Tortoise ORM](https://github.com/tortoise/tortoise-orm) - Async ORM for Python
+
+---
+
+**Made with ❤️ by [AbigailWilliams1692](https://github.com/AbigailWilliams1692)**

data_retrieval_module-1.0.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+data_retrieval/__init__.py,sha256=uJboXyByW_UUD1UF7Si1APOxUGmGPAZMSBcVO2m2wuo,2000
+data_retrieval/py.typed,sha256=-NTLJWHpx_8vs__Ouvm4nvtZ1-l6FqRKyJ2iqfxmutE,158
+data_retrieval/model/__init__.py,sha256=ZVqtFkRxqTCiqyOfKEeJ7XVNBreQLsN5GRnf-bOOJNk,432
+data_retrieval/model/data_module.py,sha256=CWBRh35_4UV7PQ0pz0bl2xgi45Otd_z5rgi1rBlIlYI,4281
+data_retrieval/model/data_provider.py,sha256=i5D12nwYOVGopVemBlAoX6BhC0wrw3ftNQyifESQjII,10315
+data_retrieval/model/exceptions.py,sha256=ySs--qJ9fJV-cprAb69peZhQx1ppv5RbzK5nbjDQjUc,1169
+data_retrieval_module-1.0.0.dist-info/licenses/LICENSE,sha256=Mcf9NKkIfu5xuYsMLyvzhYXnm9OwZ8jko8scfkocBBU,1073
+data_retrieval_module-1.0.0.dist-info/METADATA,sha256=uAY7libj5VgumIrLjGVYc797MbFcXUCJqgLr4PxKjzo,10150
+data_retrieval_module-1.0.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+data_retrieval_module-1.0.0.dist-info/top_level.txt,sha256=02EwIYUSaidyp_6eSOKa1TTYSE71RmhFlpkgI5OQ6nk,15
+data_retrieval_module-1.0.0.dist-info/RECORD,,

data_retrieval_module-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

data_retrieval_module-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Abigail Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data_retrieval_module-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+data_retrieval