Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 2.3 KB

File metadata and controls

72 lines (56 loc) · 2.3 KB

Changelog

All notable changes to the Scintirete Python SDK will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • Initial release of Scintirete Python SDK
  • Synchronous client (ScintireteClient)
  • Asynchronous client (ScintireteAsyncClient)
  • Complete API coverage for all Scintirete operations
  • Comprehensive type definitions and data models
  • Rich error handling with specific exception types
  • Connection pooling and compression support
  • Context manager support for automatic resource cleanup
  • Extensive unit tests and integration tests
  • Detailed documentation and examples

Features

  • Database Operations: Create, drop, and list databases
  • Collection Operations: Create, drop, list, and get collection information
  • Vector Operations: Insert, delete, and search vectors with metadata
  • Text Embedding: Automatic text embedding with configurable models
  • Persistence: Synchronous and background save operations
  • Performance: Optimized for high-throughput operations
  • Reliability: Built-in retry mechanisms and graceful error handling

Supported Python Versions

  • Python 3.9+
  • Async support with asyncio
  • Type hints compatible with mypy

Dependencies

  • grpcio>=1.60.0 - Core gRPC support
  • protobuf>=4.21.0 - Protocol buffer support

[0.1.0] - 2024-01-XX

Added

  • Initial beta release
  • Core functionality implementation
  • Basic documentation

Known Issues

  • None currently identified

Migration Guide

  • First release, no migration needed

Development Notes

Release Process

  1. Update version in pyproject.toml
  2. Update CHANGELOG.md with new version
  3. Create git tag: git tag v0.1.0
  4. Build package: make build
  5. Publish to PyPI: make publish

Breaking Changes Policy

  • Major version bumps (1.0.0 → 2.0.0) may include breaking changes
  • Minor version bumps (1.0.0 → 1.1.0) add features without breaking existing code
  • Patch version bumps (1.0.0 → 1.0.1) include bug fixes only

Support Policy

  • Latest major version receives all updates
  • Previous major version receives security updates for 12 months
  • Beta versions receive updates until stable release