Skip to content

Latest commit

History

History
37 lines (30 loc) 路 1.55 KB

File metadata and controls

37 lines (30 loc) 路 1.55 KB

Changelog

All notable changes to this project will be documented in this file.

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

[3.0.0] - 2024-08-06

Added

  • Python package distribution support (pip/uv installable)
  • High-level LLMocal convenience class for easy programmatic usage
  • Public API with easy imports: import llmocal
  • Package metadata and URLs for PyPI distribution
  • MANIFEST.in for proper file inclusion in distribution
  • Enhanced README with installation and usage examples
  • Explicit model download API with download_model() method
  • Better developer experience with clear error messages

Changed

  • BREAKING: Models are NO LONGER downloaded automatically on first run
  • Developers must explicitly call download_model() or setup(auto_download=True)
  • Improved __init__.py with public API and usage examples
  • Enhanced pyproject.toml with complete package metadata
  • Added project URLs for better discoverability
  • Reset version to 0.0.1 for initial PyPI release

Fixed

  • Import error handling during package installation
  • Package structure for better distribution compatibility
  • Clear error messages when models are not found locally

Developer Experience

  • Explicit model management: No surprise downloads
  • Clear error messages: Helpful guidance when models are missing
  • Flexible setup options: auto_download=True for convenience
  • Professional packaging: Follows modern Python standards