Skip to content

v0.3.0 - Documentation and Concurrency Update

Choose a tag to compare

@bdamokos bdamokos released this 24 Dec 14:51
· 45 commits to main since this release

This release introduces comprehensive documentation and robust concurrency support, making the library more reliable for multi-threaded and multi-process applications.

Major Features

Detailed Changes

Documentation

  • Comprehensive documentation site with quick start guide, API reference, and examples
  • Improved inline documentation and type hints
  • Better error messages and logging

Concurrency Support

  • File locking for concurrent metadata access
  • Shared locks for reading (multiple readers allowed)
  • Exclusive locks for writing (one writer at a time)
  • Automatic metadata merging for concurrent writes

API Improvements

  • Made API instances fully independent with separate data directories
  • Added reload_metadata() method for manual metadata refresh
  • Added ensure_metadata_current() for automatic metadata validation
  • Improved handling of corrupted metadata files

Developer Changes

  • Added automated test issue management
  • Added comprehensive test suite for concurrent operations
  • Improved GitHub Actions security
  • Added documentation testing workflows

Full Changelog: v0.2.0...v0.3.0