- Create DeltaGliderClient with user-friendly interface
- Add create_client() factory function with sensible defaults
- Implement UploadSummary dataclass with helpful properties
- Expose simplified API through main package
- Add comprehensive SDK documentation under docs/sdk/:
- Getting started guide with installation and examples
- Complete API reference documentation
- Real-world usage examples for 8 common scenarios
- Architecture deep dive explaining how DeltaGlider works
- Automatic documentation generation scripts
- Update CONTRIBUTING.md with SDK documentation guidelines
- All tests pass and code quality checks succeed
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Use setuptools-scm for automatic version detection
- Version now automatically derived from git tags
- No need to manually update version in pyproject.toml
- Added _version.py to .gitignore
This enables automatic patch version bumping through git tags without
manually updating any configuration files.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Renamed Leaf class to DeltaSpace throughout the codebase
- Updated all imports, method signatures, and variable names
- Updated documentation and comments to reflect the new naming
- DeltaSpace better represents a container for delta-compressed files
The term "DeltaSpace" is more semantically accurate than "Leaf" as it
represents a space/container for managing related files with delta
compression, not a terminal node in a tree structure.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Add three methods for credential configuration (env vars, AWS profiles, explicit)
- Show complete service initialization with all adapters
- Add MinIO and Cloudflare R2 specific examples
- Include file upload, download, and verification examples
- Show how to access compression statistics
- Add advanced usage with should_use_delta() method
- Provide full import statements for clarity
- Explain xdelta3's block-level matching and rolling hash algorithm
- Compare with other diff algorithms (text diff, bsdiff, courgette)
- Add real-world JAR file example showing compression ratios
- Enhance file type table with 'Why It Works' column
- Clarify why archives achieve 99%+ compression
- Drop-in replacement for AWS S3 CLI (cp, ls, rm, sync commands)
- Binary delta compression using xdelta3
- Hexagonal architecture with clean separation of concerns
- Achieves 99.9% compression for versioned files
- Full test suite with 100% passing tests
- Python 3.11+ support
DeltaGlider reduces storage costs by storing only binary deltas between
similar files. Achieves 99.9% compression for versioned artifacts.
Key features:
- Intelligent file type detection (delta for archives, direct for others)
- Drop-in S3 replacement with automatic compression
- SHA256 integrity verification on every operation
- Clean hexagonal architecture
- Full test coverage
- Production tested with 200K+ files
Case study: ReadOnlyREST reduced 4TB to 5GB (99.9% compression)
