Skip to content

Version 1.0.6

Choose a tag to compare

View all tags
@ivbeg ivbeg released this 01 Nov 08:48
· 57 commits to main since this release
v1.0.6
ecc6187

Release Notes - Version 1.0.6

Release Date: December 2024

Overview

Version 1.0.6 focuses on improving documentation, developer experience, and release automation. This release enhances the project's usability with comprehensive documentation and automated release workflows.

What's New

📚 Enhanced Documentation

  • Comprehensive README: Complete rewrite with detailed usage examples covering all major features
  • API Reference: Added comprehensive API documentation for all public functions and classes
  • Usage Examples: Expanded examples section with real-world use cases:
    • Format conversion workflows
    • Pipeline processing
    • DuckDB engine integration
    • Bulk operations
    • Excel and XML processing
  • Quick Start Guide: Added quick start section for immediate productivity

🤖 GitHub Actions Release Automation

  • Automatic Release Generation: New GitHub Actions workflow that:
    • Automatically triggers on version tags (e.g., v1.0.6)
    • Verifies version consistency between tag and package
    • Runs full test suite before release
    • Builds source distribution and wheel packages
    • Creates GitHub releases with proper formatting
    • Supports optional PyPI publishing
  • CI/CD Integration: Streamlined release process with automated validation

📖 Changelog and Release Tracking

  • Added CHANGELOG.md following Keep a Changelog format
  • Release notes tracking for future versions
  • Better version history visibility

Improvements

Documentation

  • Better organized README with clear sections
  • More practical, copy-paste ready examples
  • Improved formatting and readability
  • Added missing API documentation

Developer Experience

  • Automated release process reduces manual steps
  • Clear version management workflow
  • Better onboarding for new contributors

Installation

pip install iterabledata==1.0.6

Or upgrade from a previous version:

pip install --upgrade iterabledata

Migration Guide

No breaking changes in this release. All existing code should work without modification.

Full Changelog

See CHANGELOG.md for detailed changes.

Contributing

We welcome contributions! Please see the Contributing section in the README for guidelines.

Feedback

If you encounter any issues or have suggestions, please open an issue on GitHub.

Acknowledgments

Thank you to all contributors and users of iterabledata!

Assets 4
Loading