Skip to content

CHANGELOG.md

Latest commit

 

History

History
121 lines (99 loc) · 6.35 KB

CHANGELOG.md

File metadata and controls

121 lines (99 loc) · 6.35 KB

Changelog

All notable changes to the HeySol API Client will be documented in this file.

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

[1.3.0] - 2025-10-01

Added

  • 🏆 Enterprise Code Quality - Comprehensive quality assurance with 100% compliance
  • 🔧 Automated Quality Tools - mypy type checking, ruff linting, black formatting, isort organization
  • 🧪 Quality Validation Pipeline - Complete automated validation workflow
  • 📊 Quality Metrics Tracking - 100% success rates across all validation categories
  • 🏷️ Quality Badges - Visual indicators of code quality status in documentation

Quality Improvements

  • ✅ Syntax Validation: All Python files compile successfully (26+ files)
  • ✅ Import Testing: All main module imports work correctly across entire codebase
  • ✅ Type Checking: All packages pass mypy validation (21 source files total)
  • ✅ Linting: All ruff linting checks passed with full PEP 8 compliance
  • ✅ Formatting: All files properly formatted with black (26 files verified)
  • ✅ Import Organization: All imports properly organized with isort
  • ✅ Standards Compliance: 100% PEP 8, PEP 257, PEP 484 compliance

Fixed

  • 🔧 Pylance Type Errors: Fixed type checking errors in test_models.py with appropriate type ignore comments
  • 🔧 Test Validation: Maintained test validation logic while resolving type checker warnings
  • 🔧 Code Quality: Enhanced overall code quality with enterprise-grade standards

Changed

  • 📚 Documentation: Updated README.md with quality verification status and current version
  • 📋 Quality Standards: Established comprehensive quality gates for future development
  • 🏗️ Development Workflow: Integrated automated quality validation into development process

[1.3.0] - 2025-09-30

Added

  • CLI Polish: Complete CLI help system overhaul with professional formatting and comprehensive documentation
  • CLI Testing: Added 47 comprehensive CLI polish tests covering all help outputs and formatting
  • Command Descriptions: Enhanced all command groups with detailed, descriptive help text following Typer best practices
  • Test Integration: Integrated test_all_help.py into pytest infrastructure as test_all_cli_help.py
  • Import Fixes: Resolved all relative import issues across CLI modules for better maintainability

Changed

  • CLI Help Output: Streamlined main help output by removing verbose setup instructions and examples
  • Command Structure: Improved command descriptions for better user experience:
    • logs: "Manage ingestion logs, status, and log operations"
    • memory: "Memory operations: ingest, search, queue, and episode management"
    • spaces: "Space management: create, list, update, delete, and bulk operations"
    • profile: "User profile and API health check operations"
    • registry: "Manage registered HeySol instances and authentication"
    • tools: "List MCP tools and integrations"
    • webhooks: "Webhook management: create, list, update, delete webhooks"
  • Test Coverage: Enhanced CLI testing with polish validation tests for accuracy, completeness, and accessibility

Fixed

  • Import Issues: Fixed relative import problems in CLI modules that were causing test failures
  • Test Dependencies: Updated test imports to use proper module paths (src.cli instead of cli)
  • Help Consistency: Ensured consistent help formatting and descriptions across all CLI modules

[1.2.1] - 2025-09-28

Added

  • CLI Enhancement: Added logs get-by-source command for filtering logs by source identifier
  • CLI Enhancement: Added logs sources command to list all unique sources from memory logs
  • Log Management: Enhanced log filtering capabilities with dedicated source-based queries
  • Documentation: Refreshed all documentation for GitHub presentation
  • Version Alignment: Synchronized version numbers across all configuration files

Changed

  • CLI Commands: Renamed log commands to follow API naming conventions:
    • logs delete now deletes a specific log entry by ID (single item)
    • logs delete-by-source now deletes logs by source (batch operation)

[0.9.1] - 2025-09-24

Added

  • CLI Tool: Complete command-line interface for all operations (heysol-client)
  • Source Filtering: MCP-based source filtering for logs and search operations
  • MCP Protocol Support: Full Model Context Protocol integration with 100+ tools
  • Memory Management: Ingest, search, and manage memory spaces
  • Space Operations: Complete CRUD operations for memory spaces
  • Log Management: Get, list, and delete ingestion logs with source filtering
  • User Profile: Get current user profile information
  • Error Handling: Comprehensive exception hierarchy with retry mechanisms
  • Configuration: Flexible configuration via environment variables, files, or parameters

Features

  • Source-Aware Operations: All operations support source identification and filtering
  • MCP Integration: Primary access method with fallback to direct API
  • Lean Design: Minimal dependencies, performant, and maintainable codebase
  • Type Hints: Full type annotation support
  • Documentation: Comprehensive README, API docs, and usage examples

CLI Commands

  • heysol-client profile - Get user profile
  • heysol-client spaces list - List spaces
  • heysol-client spaces create "name" - Create space
  • heysol-client ingest "message" - Ingest data
  • heysol-client search "query" - Search memory
  • heysol-client logs list - List logs
  • heysol-client logs get-by-source "source" - Get logs by source
  • heysol-client logs delete-by-source "source" --confirm - Delete logs by source
  • heysol-client tools - List MCP tools

Examples

  • source_filtering_demo.py - Comprehensive source filtering operations
  • cli_source_filtering_demo.py - CLI usage demonstration
  • basic_usage.py - Basic client operations
  • log_management.py - Log management operations

Technical Details

  • Python: 3.8+ support
  • Dependencies: requests, aiohttp, python-dotenv
  • License: MIT
  • Packaging: PyPI ready with complete metadata

HeySol API Client - A production-ready Python client for the HeySol API with MCP protocol support and comprehensive CLI tooling.