Skip to content

CHANGELOG.md

Latest commit

 

History

History
129 lines (71 loc) · 7.77 KB

CHANGELOG.md

File metadata and controls

129 lines (71 loc) · 7.77 KB

Changelog

All notable changes to stackvox are documented in this file.

The format follows Keep a Changelog and this project adheres to Semantic Versioning.

From v0.2.1 onwards, entries in this file are generated by release-please from conventional commits; earlier entries (v0.2.0 and below) were written by hand.

0.5.0 (2026-04-30)

Features

  • surface update info via status and daemon startup (#23) (6f0a405)

Bug Fixes

  • ci: filter Kokoro release check to releases with general assets (#26) (9aa60da)

Continuous Integration

  • weekly check for new Kokoro model releases (#24) (f62c91b)

0.4.0 (2026-04-30)

Features

  • per-user TOML config for default voice/speed/lang (#19) (2eaefff)

Documentation

  • add demo audio + comparison table to README (#21) (ce39be2)

Chores

  • enable mypy disallow_untyped_defs for stackvox/ (#20) (a2072af)

0.3.1 (2026-04-30)

Chores

  • replace [tool.setuptools] script-files with stackvox install-helper (#18) (d837f26)

Tests

0.3.0 (2026-04-29)

Features

  • cli: stdin support, download progress, bash completion, thread-safe defaults (#11) (2ae8f85)
  • daemon: refresh audio only when default output device changes (#13) (dd68606)

Chores

  • daemon: surface AudioObjectAddPropertyListener failures, type _ca_refs (#14) (35368f6)

0.2.1 (2026-04-22)

Bug Fixes

  • release-please should use v{version} tags, not stackvox-v{version} (#10) (baee1d8)

Continuous Integration

  • add macOS test row; docs: examples README + security notes (#9) (c6e53f7)

Chores

  • add CODEOWNERS (#6) (6321894)
  • deps: bump the actions group across 1 directory with 3 updates (1b65b4c)
  • deps: bump the actions group across 1 directory with 3 updates (82131fd)
  • prep repo for going public (#8) (861d1fa)

0.2.0 - 2026-04-22

First open-source release. Adds packaging/licensing hygiene, a full test + CI + release pipeline, and a quality-of-life fix for audio device switches.

Added

  • Daemon automatically refreshes PortAudio before each utterance, so switching the system output device (e.g. plugging in Bluetooth headphones) no longer requires a daemon restart.
  • python -m stackvox entry point.
  • stackvox.paths module exposing cache_dir(), socket_path(), and pid_path() as public API.
  • LICENSE (Apache 2.0), NOTICE with third-party attributions, CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md (Contributor Covenant 2.1).
  • GitHub issue templates (bug report, feature request) and a pull-request template.
  • Test suite under tests/ covering path resolution, CLI argument routing, and the daemon socket protocol.
  • stackvox/py.typed marker so downstream type checkers honour the inline type hints.
  • GitHub Actions CI running ruff lint/format, mypy, and pytest across Python 3.10 – 3.13 on Ubuntu, plus commit-message and PR-title validation.
  • Test coverage reporting via pytest-cov, uploaded to Codecov.
  • README badges for CI, coverage, Python version, and license.
  • dev optional dependency group (pytest, pytest-mock, pytest-cov, ruff, pre-commit, commitizen, mypy).
  • Ruff, mypy, pytest, and coverage configuration in pyproject.toml.
  • Project metadata: SPDX license expression, authors, keywords, project URLs, classifiers.
  • .pre-commit-config.yaml wiring ruff hooks plus a commitizen commit-msg hook for local conventional-commit enforcement.
  • .github/dependabot.yml — weekly pip and GitHub Actions updates.
  • Release automation via release-please: merging conventional-commit PRs rolls a release PR that, when merged, tags the commit and publishes to PyPI via Trusted Publishing (OIDC — no API tokens stored in the repo).
  • PR-title validation workflow (amannn/action-semantic-pull-request) for squash-merge flows where the PR title becomes the commit on main.

Changed

  • Library modules (engine.py, daemon.py) emit diagnostics via logging instead of print(). The CLI configures basicConfig at entry so output shape is unchanged for users.
  • Example scripts moved from the repo root to examples/.
  • stackvox.__version__ is now read from installed package metadata, so pyproject.toml is the single source of truth for the version.
  • Magic numbers in daemon.py (worker poll interval, client/ping timeouts, recv buffer size) promoted to named module constants.

Internal

  • Promoted stackvox.engine._cache_dir (private) to stackvox.paths.cache_dir() (public); daemon.py no longer reaches across module boundaries into a private helper.
  • Two small type-safety fixes (typed the signal-handler frame parameter; narrowed _read_text's argparse Namespace access to avoid an Any return) so mypy runs cleanly.

0.1.0 - 2026-04-17

Initial commit. Offline TTS using Kokoro-82M via kokoro-onnx, with a Python library, CLI, and a long-running daemon driven over a unix socket for low-latency shell access.