gapless-crypto-data 2.7.0__tar.gz → 2.9.0__tar.gz

{gapless_crypto_data-2.7.0 → gapless_crypto_data-2.9.0}/.gitignore

@@ -12,3 +12,5 @@ venv/
 env/
 test-env/
 *-env/
+# Gapless Crypto Data checkpoint files (auto-generated during collection)
+.gapless_checkpoints/

gapless_crypto_data-2.9.0/AUTHORS.md

@@ -0,0 +1,72 @@
+# Authors and Contributors
+
+This file lists the people who have contributed to the gapless-crypto-data project.
+
+## Project Maintainers
+
+**Terry Li** - *Project Lead & Primary Developer*
+- Email: terry@eonlabs.com
+- GitHub: [@terryli](https://github.com/terryli)
+- Organization: [Eon Labs](https://github.com/Eon-Labs)
+
+## Core Development Team
+
+**Eon Labs Team** - *Development & Maintenance*
+- Organization: [Eon Labs](https://github.com/Eon-Labs)
+- Focus: Quantitative trading infrastructure and machine learning for financial markets
+
+## Contributors
+
+This project welcomes contributions from the community. All contributors who submit pull requests, report issues, or provide feedback are acknowledged here.
+
+### How to Be Listed
+
+Contributors are automatically included when they:
+- Submit merged pull requests
+- Report and help resolve issues
+- Provide significant feedback or suggestions
+- Contribute to documentation
+
+### Contribution Types
+
+- **Code Contributors**: Direct code contributions via pull requests
+- **Documentation Contributors**: Documentation improvements and examples
+- **Issue Reporters**: Bug reports and feature requests
+- **Community Contributors**: Support, feedback, and community building
+
+## Acknowledgments
+
+### Third-Party Libraries
+
+This project builds upon excellent open-source libraries:
+- **pandas** - Data manipulation and analysis
+- **httpx** - Async HTTP client for Python
+- **polars** - Fast DataFrames for Python
+- **joblib** - Lightweight pipelining and caching
+- **pyarrow** - Columnar in-memory analytics
+- **pyod** - Outlier detection algorithms
+
+### Data Sources
+
+- **Binance** - Public data repository and API endpoints
+- Community feedback and testing from quantitative trading developers
+
+### Development Tools
+
+- **UV** - Modern Python package management
+- **Ruff** - Fast Python linter and formatter
+- **pytest** - Testing framework
+- **pre-commit** - Git hook management
+- **GitHub Actions** - Continuous integration and deployment
+
+## Contact
+
+For questions about contributions or to discuss the project:
+
+- **Project Issues**: [GitHub Issues](https://github.com/Eon-Labs/gapless-crypto-data/issues)
+- **Email**: terry@eonlabs.com
+- **Organization**: [Eon Labs](https://github.com/Eon-Labs)
+
+## License
+
+All contributions to this project are made under the MIT License. See [LICENSE](LICENSE) for details.

{gapless_crypto_data-2.7.0 → gapless_crypto_data-2.9.0}/CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to gapless-crypto-data 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).
 
+## [2.7.0] - 2025-09-18
+
+### CCXT-Compatible Dual Parameter Support
+
+#### Dual Parameter Implementation
+- **CCXT ecosystem compatibility** - `timeframe` parameter aligns with cryptocurrency exchange library standards
+- **Backward compatibility** - `interval` parameter maintained with 5-year deprecation period
+- **Exception-only validation** - No fallbacks or failsafes, immediate ValueError for invalid parameter combinations
+- **Community-proven patterns** - PEP 387 compliant implementation following Python backward compatibility policy
+
+#### API Changes
+- `fetch_data()` - Supports both `timeframe` (preferred) and `interval` (legacy) parameters
+- `download()` - Supports both `timeframe` (preferred) and `interval` (legacy) parameters
+- `get_supported_intervals()` - Legacy alias with DeprecationWarning, use `get_supported_timeframes()`
+- **Zero breaking changes** - All existing code continues to work with deprecation warnings
+
+#### Documentation
+- **OpenAPI 3.1.1 specification** - Machine-readable API documentation with dual parameter support
+- **Migration guidance** - Examples and patterns for transitioning to CCXT-compatible parameters
+- **Architecture status updated** - Canonical reference updated to v2.7.0
+
 ## [2.6.0] - 2025-09-18
 
 ### ✨ Major API Enhancement: Dual API Architecture

gapless_crypto_data-2.9.0/CONTRIBUTING.md

@@ -0,0 +1,244 @@
+# Contributing to Gapless Crypto Data
+
+Thank you for your interest in contributing to gapless-crypto-data! This document provides guidelines for contributing to the project.
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.9+
+- [UV package manager](https://docs.astral.sh/uv/getting-started/installation/)
+- Git
+
+### Environment Setup
+
+1. **Fork and clone the repository:**
+   ```bash
+   git clone https://github.com/your-username/gapless-crypto-data.git
+   cd gapless-crypto-data
+   ```
+
+2. **Set up development environment:**
+   ```bash
+   # Create virtual environment
+   uv venv
+
+   # Activate virtual environment
+   source .venv/bin/activate  # macOS/Linux
+   # .venv\Scripts\activate   # Windows
+
+   # Install dependencies
+   uv sync --dev
+   ```
+
+3. **Install pre-commit hooks (mandatory):**
+   ```bash
+   uv run pre-commit install
+   ```
+
+## Development Workflow
+
+### Before Making Changes
+
+1. **Create a feature branch:**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Verify setup:**
+   ```bash
+   # Run tests
+   uv run pytest
+
+   # Check code formatting
+   uv run ruff format --check .
+
+   # Check linting
+   uv run ruff check .
+   ```
+
+### Making Changes
+
+1. **Code formatting and linting:**
+   ```bash
+   # Format code
+   uv run ruff format .
+
+   # Fix linting issues
+   uv run ruff check --fix .
+
+   # Type checking
+   uv run mypy src/
+   ```
+
+2. **Running tests:**
+   ```bash
+   # Run all tests
+   uv run pytest
+
+   # Run specific test file
+   uv run pytest tests/test_specific.py -v
+
+   # Run with coverage
+   uv run pytest --cov=src/gapless_crypto_data
+   ```
+
+3. **Pre-commit validation:**
+   ```bash
+   # Run all pre-commit hooks
+   uv run pre-commit run --all-files
+   ```
+
+## Code Standards
+
+### Code Style
+
+- **Formatting**: Code is automatically formatted using Ruff
+- **Linting**: All code must pass Ruff linting checks
+- **Type hints**: Use type hints for all public APIs
+- **Docstrings**: Follow Google-style docstrings for all public functions and classes
+
+### Testing
+
+- **Test coverage**: Aim for high test coverage on new features
+- **Test structure**: Place tests in `tests/` directory
+- **Test data**: Use fixtures in `tests/fixtures/` for test data
+- **Async tests**: Mark async tests with `@pytest.mark.asyncio`
+
+### Documentation
+
+- **API documentation**: Update docstrings for any API changes
+- **README updates**: Update README.md if adding new features
+- **Changelog**: Add entries to CHANGELOG.md for significant changes
+
+## Submitting Changes
+
+### Pull Request Process
+
+1. **Ensure all checks pass:**
+   ```bash
+   uv run pytest
+   uv run ruff format --check .
+   uv run ruff check .
+   uv run mypy src/
+   uv run pre-commit run --all-files
+   ```
+
+2. **Commit changes:**
+   ```bash
+   git add .
+   git commit -m "feat: add new feature description"
+   ```
+
+3. **Push to your fork:**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+4. **Create pull request:**
+   - Navigate to the GitHub repository
+   - Click "New Pull Request"
+   - Provide clear description of changes
+   - Reference any related issues
+
+### Commit Message Format
+
+Use conventional commit format:
+
+- `feat:` - New features
+- `fix:` - Bug fixes
+- `docs:` - Documentation changes
+- `style:` - Code style changes (formatting, etc.)
+- `refactor:` - Code refactoring
+- `test:` - Adding or updating tests
+- `chore:` - Maintenance tasks
+
+Examples:
+```
+feat: add concurrent download manager
+fix: resolve gap detection edge case
+docs: update API documentation
+test: add tests for hybrid URL generator
+```
+
+## Issue Reporting
+
+### Bug Reports
+
+When reporting bugs, please include:
+
+- **Environment details**: Python version, OS, package version
+- **Reproduction steps**: Clear steps to reproduce the issue
+- **Expected vs actual behavior**: What you expected vs what happened
+- **Error messages**: Include full error messages and stack traces
+- **Sample code**: Minimal code that reproduces the issue
+
+### Feature Requests
+
+For feature requests, please include:
+
+- **Use case**: Describe the problem you're trying to solve
+- **Proposed solution**: Your suggested approach
+- **Alternatives considered**: Other solutions you've considered
+- **Additional context**: Any other relevant information
+
+## Code Review Process
+
+### Review Criteria
+
+Pull requests are reviewed for:
+
+- **Functionality**: Does the code work as intended?
+- **Code quality**: Is the code well-structured and maintainable?
+- **Tests**: Are there adequate tests for the changes?
+- **Documentation**: Is documentation updated appropriately?
+- **Compatibility**: Does it maintain backward compatibility?
+
+### Review Timeline
+
+- **Initial review**: Within 1-2 business days
+- **Follow-up**: Based on complexity and reviewer availability
+- **Merge**: After approval and passing all checks
+
+## Development Guidelines
+
+### Adding New Features
+
+1. **Design**: Consider the API design and backward compatibility
+2. **Implementation**: Follow existing patterns and conventions
+3. **Testing**: Add comprehensive tests for new functionality
+4. **Documentation**: Update relevant documentation
+5. **Examples**: Add usage examples if appropriate
+
+### Performance Considerations
+
+- **Efficiency**: Consider performance implications of changes
+- **Memory usage**: Be mindful of memory consumption
+- **Concurrency**: Ensure thread safety where applicable
+- **Testing**: Include performance tests for critical paths
+
+### Security Considerations
+
+- **Input validation**: Validate all user inputs
+- **Data handling**: Handle sensitive data appropriately
+- **Dependencies**: Keep dependencies up to date
+- **Secrets**: Never commit secrets or API keys
+
+## Getting Help
+
+### Communication Channels
+
+- **GitHub Issues**: For bug reports and feature requests
+- **GitHub Discussions**: For questions and general discussion
+- **Email**: technical questions to terry@eonlabs.com
+
+### Resources
+
+- **Documentation**: [Project README](README.md)
+- **API Reference**: See docstrings in source code
+- **Examples**: Check `examples/` directory
+- **Tests**: Review existing tests for usage patterns
+
+## License
+
+By contributing to gapless-crypto-data, you agree that your contributions will be licensed under the MIT License.

gapless_crypto_data-2.9.0/MANIFEST.in

@@ -0,0 +1,45 @@
+# Include essential project files
+include README.md
+include LICENSE
+include CHANGELOG.md
+include pyproject.toml
+include .python-version
+
+# Include documentation
+recursive-include docs *.md *.yaml *.yml
+exclude docs/guides/pypi-documentation.md
+
+# Include examples
+recursive-include examples *.py *.sh *.md
+
+# Include tests (but exclude from wheel)
+recursive-include tests *.py
+
+# Include configuration files
+include .pre-commit-config.yaml
+
+# Exclude development and cache files
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude .git*
+exclude .gitignore
+exclude .gitattributes
+
+# Exclude build and distribution artifacts
+global-exclude *.egg-info
+global-exclude build
+global-exclude dist
+global-exclude .tox
+global-exclude .coverage
+global-exclude .pytest_cache
+global-exclude .mypy_cache
+global-exclude .ruff_cache
+
+# Exclude development directories and checkpoints
+exclude test_output
+exclude .gapless_checkpoints
+
+# Exclude virtual environment
+exclude .venv