Skip to content

CHANGELOG.md

Latest commit

 

History

History
84 lines (66 loc) · 3.19 KB

CHANGELOG.md

File metadata and controls

84 lines (66 loc) · 3.19 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.

1.4.0 - 2026-03-12

New feature: easily rebrand the CLI name and executable

Added

  • Added [tool.yourcli] configuration keys in pyproject.toml for runtime branding and environment-variable behavior:
    • env_prefix (env variable prefix)
    • name (display/app name)
    • cli_name (CLI program name)

Changed

  • Refactored metadata loading to read branding/configuration from pyproject.toml so runtime values are centrally sourced.
  • Updated environment variable resolution to use the configured prefix
  • Updated README documentation to describe configurable prefixing and the new [tool.yourcli] keys.
  • Updated tests to use dynamically generated environment variable names via metadata helpers.

1.3.0 - 2026-03-08

Added

  • New admin command templates for plugin scaffolding under src/cli/commands/admin/new_command/.template/.
  • Support for no_args_is_help metadata in command/group loading and command registration.

Changed

  • Bumped project version to 1.3.0 in pyproject.toml.
  • Refactored admin new-command generation flow to require --short-help, support hierarchical parent paths via --parent, and create safer/clearer plugin skeleton output.
  • Standardized command metadata keys to snake_case (short_help, help_group) while keeping compatibility with legacy aliases.
  • Updated command metadata defaults and visibility behavior across admin/sample command specs.
  • Improved command discovery to ignore dot-prefixed support directories in addition to interpreter artifact directories.
  • Expanded CLI/loader test coverage for nested generation, metadata validation, ignored directories, and new command options.
  • Regenerated lockfile content and package source metadata in uv.lock.

1.2.0 - 2026-02-12

Changed

  • Various fixes/improvements and shuffling of directory layout.

1.1.0 - 2026-02-09

Added

  • New Makefile stage install for local editable developer install
  • Additional tests, improving code coverage to >90%

Changed

  • Numerous linting and formatting fixes
  • Documentation in the README.md file
  • Modified Makefile stage clean to also remove the .venv directory

1.0.0 - 2026-02-08

Added

  • Initial project structure with src/ and test/ directories
  • Hello World example script (src/hello-world.py)
  • Comprehensive Makefile with common development tasks
  • uv-based dependency management
  • Code quality tooling: Ruff (linting + formatting) and Pyright (type checking)
  • Testing framework with pytest and pytest-cov
  • Security scanning with pip-audit and bandit
  • Environment-based configuration support (.env files)
  • Test suite for hello-world module
  • Project documentation (README.md)
  • MIT License
  • .gitignore for Python projects

References