Skip to content

CHANGELOG.md

Latest commit

 

History

History
277 lines (177 loc) · 8.72 KB

CHANGELOG.md

File metadata and controls

277 lines (177 loc) · 8.72 KB
Raw

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.

Unreleased

0.21.0 - 2026-01-09

Changed

  • BREAKING: HeadlineListItem model removed and merged into HeadlineDetails (now a type alias for backward compatibility)
  • Refactored internal operations structure to use mixins for better code organization
  • Improved bulk operations with generic validation and processing helpers in base classes
  • Standardized error handling across all operations to consistently use raise_for_status()

Added

  • New mixins/ folder with transform mixins for each operation type (goals, meetings, issues, headlines, todos, users)
  • Generic bulk operation helpers in AbstractOperations base class (_validate_bulk_item, _process_bulk_sync)
  • Generic async bulk processing in AsyncBaseOperations with configurable semaphore for concurrency control
  • Reusable OptionalDatetime and OptionalFloat annotated types using Pydantic's BeforeValidator

Fixed

  • Removed duplicate datetime and float validators across models (Todo, Issue, Goal)
  • Removed redundant __init__ methods from async operations

0.20.1 - 2025-12-10

Fixed

  • Fix CompletionDate field mapping in MeetingOperations to use CompleteTime instead of CloseTime (sync/async consistency)
  • Fix Configuration.configure_api_key() documentation to use correct instance method pattern
  • Add missing AuthenticationError documentation with usage examples
  • Update dependencies list in documentation (add pydantic, typing-extensions)
  • Fix code examples to use correct model field names (complete_date)
  • Add bulk operations documentation for todos, issues, goals, and meetings
  • Clarify default user ID behavior in user operations documentation
  • Update method signatures and return types in API reference
  • Fix async concurrency control documentation (max_concurrent parameter)
  • Improve error handling examples throughout guides

0.20.0 - 2025-12-10

Added

  • client.issue.update() method for updating existing issues
  • client.scorecard.get() method for retrieving scorecard details
  • GoalStatus enum for type-safe status values
  • base_url and timeout parameters to sync Client for configuration flexibility
  • AsyncClient now validates API key at initialization

Changed

  • BREAKING: client.user.all() renamed to client.user.list() for consistency
  • BREAKING: client.user.details(all=True) renamed to client.user.details(include_all=True) for clarity
  • BREAKING: client.issue.solve() renamed to client.issue.complete() and now returns IssueDetails
  • BREAKING: client.todo.complete() now returns Todo instead of bool
  • BREAKING: client.goal.update/delete/archive/restore() now return None instead of bool
  • BREAKING: client.headline.update/delete() now return None instead of bool
  • BREAKING: Client raises ConfigurationError instead of ValueError for missing API key

Fixed

  • All documentation updated to reflect the breaking changes

0.19.0 - 2025-12-10

Fixed

  • Made Position.name field optional to handle null API responses from Bloom Growth API
  • Fixes Pydantic validation errors in UserOperations.positions(), details(include_positions=True), and details(all=True)

0.18.0 - 2025-12-08

Added

  • Async bulk operations with rate limiting for goals, todos, issues, and meetings
  • Performance benchmarks documentation for async operations

Fixed

  • Corrected API endpoints and field mappings in async operations

0.17.0 - 2025-12-07

Added

  • Batch read operation for meetings via client.meeting.get_many()
  • Documentation and examples for batch operations

0.16.0 - 2025-12-06

Added

  • Claude AI agent configurations and settings for development workflow
  • Specialized subagents for manager-mode workflow

Changed

  • Streamlined CLAUDE.md to focus on architecture and development commands

0.15.0 - 2025-12-05

Added

  • Comprehensive VS Code devcontainer support for consistent development environment
  • GitHub CLI integration in devcontainer

0.14.0 - 2025-12-04

Added

  • Bulk creation methods for issues, todos, goals, and meetings
  • Comprehensive test suite for bulk operations
  • Bulk operations guide documentation

0.13.2 - 2025-12-03

Fixed

  • Adjusted scorecard typing expectations

0.13.1 - 2025-12-02

Added

  • Comprehensive ruff linting rules with preview features enabled

Fixed

  • All linting issues identified by new ruff rules

0.13.0 - 2025-12-01

Added

  • Full async/await support with AsyncClient
  • Async operations for goals, headlines, issues, and scorecard
  • pytest-asyncio for async test support

0.12.0 - 2025-11-30

Fixed

  • Documentation to match actual SDK implementation
  • GitHub/PyPI URLs in documentation
  • Authentication guide documentation
  • API key retrieval documentation examples

Removed

  • Incorrect licensing information

0.11.0 - 2025-11-29

Added

  • Informational badges to README

Changed

  • Simplified API description in documentation

Removed

  • Ruby workflows from GitHub Actions

0.10.0 - 2025-11-28

Fixed

  • Documentation and implementation mismatches
  • SDK models to match actual API responses
  • Client API key initialization priority

0.9.0 - 2025-11-27

Added

  • MkDocs documentation with Material theme
  • Dynamic version loading from pyproject.toml

Fixed

  • Docstring example formatting for mkdocs
  • Documentation to accurately reflect Pydantic model returns

0.8.0 - 2025-11-26

Changed

  • Switched to pyright strict mode for enhanced type safety

Fixed

  • All type and linting issues for strict mode compliance

0.7.0 - 2025-11-25

Added

  • Pydantic for enhanced data validation and type safety

Fixed

  • Ruff line length configuration
  • Pyright TypedDict access issues

Removed

  • Examples folder

0.6.0 - 2025-11-24

Added

  • Claude AI instructions for development assistance

0.5.0 - 2025-11-23

Added

  • Python version specification in pyproject.toml

Fixed

  • Removed tracked files that should be ignored

0.4.0 - 2025-11-22

Fixed

  • All ruff check issues

0.1.0 - 2025-11-21

Added

  • Initial Python SDK implementation migrated from Ruby
  • Core client with authentication support
  • User operations: get details, search, list all users, get direct reports/positions
  • Meeting operations: CRUD operations, get attendees/issues/todos/metrics
  • Todo operations: CRUD for user or meeting todos
  • Goal (Rock) operations: CRUD, archive/restore functionality
  • Scorecard operations: get current week, list/update scores
  • Issue operations: create, list, solve issues
  • Headline operations: CRUD for meeting headlines
  • Configuration management with multiple API key sources
  • httpx-based HTTP client with bearer token authentication