Skip to content

v0.6.3 - Code Clarity Improvement (2025-12-26)

What Changed?

This release improves code clarity by renaming device variables throughout the codebase. The variable dev has been renamed to detector in all CLI commands and example scripts to better reflect that the code is working with an OSECHI cosmic ray detector, not a generic device. This is a refactoring-only release with no functional changes.

What's New

Main Feature: Improved Code Clarity

What it does: Renames device context variables from the generic dev to the more specific detector across all modules. This makes the code's intent clearer and improves readability for developers working with the OSECHI detector.

How to use it: No changes needed for end users. Library API and CLI interface remain unchanged. Developers reading the source code will find more descriptive variable names.

Code example:

Before:

with device(port, mock=mock) as dev:
    cmd = Command(dev)
    measure = Measure(dev, config)

After:

with device(port, mock=mock) as detector:
    cmd = Command(detector)
    measure = Measure(detector, config)

Installation

Quick Start

# Get the release
git checkout v0.6.3

# Setup
uv sync

# Run CLI
uv run kazunoko --help

What's Different from the Last Version?

✅ Changed

  • Renamed device variables from dev to detector in src/kazunoko/cli.py
  • Renamed device variables from dev to detector in examples/get_events.py
  • Renamed device variables from dev to detector in examples/get_runs.py
  • Renamed device variables from dev to detector in examples/get_thresholds.py (including function parameters)
  • Renamed device variables from dev to detector in examples/template_minimal.py

Is It Safe to Upgrade?

Backward Compatible: Yes

This is a pure refactoring release with no API changes, no behavioral changes, and no breaking changes. All existing functionality works exactly as before.

Tests Passed

  • ✅ Code builds without errors
  • ✅ Pre-commit hooks pass
  • ✅ Conventional commit validation passes

Release Details

  • Date: 2025-12-26
  • Version: v0.6.3
  • Files Changed: 5
  • Commits:
  • 343fa03: refactor: rename device variable from 'dev' to 'detector' in get_events.py
  • 53cc502: refactor: rename device variable from 'dev' to 'detector' in get_runs.py
  • 9b0f1de: refactor: rename device variable from 'dev' to 'detector' in get_thresholds.py
  • efae6d6: refactor: rename device variable from 'dev' to 'detector' in template_minimal.py
  • 36fad60: refactor: rename device variable from 'dev' to 'detector' in cli.py
  • d94ab80: bump: version 0.6.2 → 0.6.3

Next Steps

The next release will focus on adding new features or fixing reported issues. As always, user feedback is welcome.