data-retrieval-module 1.0.0__tar.gz

data_retrieval_module-1.0.0/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-01-14
+
+### Added
+- Initial release of Data Retrieval Module
+- Synchronous `DataProvider` abstract base class
+- Asynchronous `AsyncDataProvider` abstract base class
+- Standardized `QueryResult` data container
+- Connection management with context managers
+- Built-in retry logic with configurable parameters
+- Hook methods for validation and transformation
+- Comprehensive exception hierarchy
+- Full type hints and generic support
+- Comprehensive unit test suite (41 tests)
+- PyPI package configuration
+- Development tools configuration (black, isort, mypy, pytest)
+
+### Features
+- **Dual API Support**: Both sync and async interfaces
+- **Connection Management**: Automatic connection handling
+- **Retry Logic**: Configurable retry mechanisms
+- **Type Safety**: Full type annotations
+- **Error Handling**: Specific exception types
+- **Testing**: Complete test coverage
+- **Documentation**: Comprehensive README and API docs
+
+### Documentation
+- Complete README with usage examples
+- API documentation for all classes
+- Development setup instructions
+- Contributing guidelines
+
+### Development
+- Setuptools and pyproject.toml configuration
+- Pre-commit hooks configuration
+- CI/CD ready setup
+- Package publishing configuration
+
+## [Unreleased]
+
+### Planned
+- Additional data source implementations
+- Performance benchmarks
+- Advanced caching mechanisms
+- Metrics and monitoring support
+- Integration with popular ORMs
+
+---
+
+## Version History
+
+### v1.0.0-alpha (2025-11-13)
+- Initial concept and design
+- Basic abstract classes
+- Core functionality implementation
+
+### v1.0.0-beta (2025-12-01)
+- Added async support
+- Improved error handling
+- Enhanced testing coverage
+- Documentation improvements
+
+### v1.0.0 (2026-01-14)
+- Production-ready release
+- Complete test suite
+- PyPI publishing configuration
+- Final documentation

data_retrieval_module-1.0.0/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/MANIFEST.in

@@ -0,0 +1,36 @@
+# Include additional files in the distribution
+
+# Documentation
+include README.md
+include CHANGELOG.md
+include LICENSE
+
+# Configuration files
+include pyproject.toml
+include setup.py
+
+# Type information
+include data_retrieval/py.typed
+
+# Test files (optional - for source distributions)
+recursive-include tests *.py
+include pytest.ini
+include requirements-test.txt
+
+# Development files (optional)
+include Makefile
+recursive-include .benchmarks *.py
+
+# Exclude unnecessary files
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude *.pyd
+global-exclude __pycache__
+global-exclude .git*
+global-exclude .pytest_cache
+global-exclude .mypy_cache
+global-exclude .coverage
+global-exclude htmlcov
+global-exclude *.egg-info
+global-exclude build
+global-exclude dist

data_retrieval_module-1.0.0/Makefile

@@ -0,0 +1,65 @@
+# Makefile for Data Retrieval Module Testing
+# Author: AbigailWilliams1692
+# Created: 2025-11-13
+# Updated: 2025-01-14
+
+.PHONY: help test test-unit test-integration test-async test-coverage test-all clean install format lint
+
+# Default target
+help:
+	@echo "Available commands:"
+	@echo "  help          - Show this help message"
+	@echo "  install       - Install test dependencies"
+	@echo "  test          - Run all tests"
+	@echo "  test-unit     - Run unit tests only"
+	@echo "  test-integration - Run integration tests only"
+	@echo "  test-async    - Run async tests only"
+	@echo "  test-coverage - Run tests with coverage"
+	@echo "  test-all      - Run all test suites with coverage"
+	@echo "  format        - Format code with black and isort"
+	@echo "  lint          - Run linting with flake8 and mypy"
+	@echo "  clean         - Clean test artifacts"
+
+# Installation
+install:
+	pip install -r requirements-test.txt
+
+# Testing
+test:
+	pytest tests/ -v
+
+test-unit:
+	pytest tests/ -v -m "unit"
+
+test-integration:
+	pytest tests/ -v -m "integration"
+
+test-async:
+	pytest tests/ -v -m "async_test"
+
+test-coverage:
+	pytest tests/ --cov=data_retrieval --cov-report=html --cov-report=term
+
+test-all:
+	pytest tests/ --cov=data_retrieval --cov-report=html --cov-report=term --cov-report=xml
+
+# Code quality
+format:
+	black tests/ data_retrieval/
+	isort tests/ data_retrieval/
+
+lint:
+	flake8 tests/ data_retrieval/
+	mypy data_retrieval/
+
+# Cleanup
+clean:
+	find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
+	find . -type d -name "*.egg-info" -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete
+	rm -rf .coverage htmlcov/ pytest.xml .pytest_cache/ .mypy_cache/
+
+# Development helpers
+dev-test: format lint test
+
+ci-test: install test-all

data_retrieval_module-1.0.0/PKG-INFO

@@ -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)**