Changelog for clack

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

No notable changes have been made.

0.3.12 - 2024-04-05

Changed

  • Change the make_config_file() pytest plugin fixture from “function”-scoped to “session”-scoped.

0.3.11 - 2024-04-04

Fixed

  • Fix clack.Parser() when called from a subpackage (e.g. zorg.app).

0.3.10 - 2024-03-31

Changed

0.3.9 - 2024-03-07

Added

  • Exposed the clack_envvars_set() method to the public clack API.

0.3.8 - 2024-03-07

Added

  • Added support for reading -v option when initializing logrus the first time.

Changed

  • Default to using colored log messages when initializing logrus the first time.

0.3.7 - 2024-03-06

Changed

  • Decided to use the distribution name instead of the package name for the --version option.

Miscellaneous

  • Emit warning log messages if clack is unable to construct the message associated with the --version option.

0.3.6 - 2024-03-05

Fixed

  • Use package name instead of dist name in the message output by the --version option.

0.3.5 - 2024-03-05

Fixed

  • Fix the --version option.

0.3.4 - 2022-05-09

Fixed

  • Fix the clack.get_config() function.

0.3.3 - 2022-05-06

Added

  • Add clack.get_config() function.

0.3.2 - 2022-01-14

Miscellaneous

  • Updated typist version to 0.2.0.

0.3.1 - 2022-01-09

Added

  • Add clack.register_runner_factory() function.

Changed

  • The ClackConfigFile.set() method now returns an eris.LazyResult type.

0.3.0 - 2022-01-08

Changed

  • BREAKING CHANGE: Migrated all types / protocols to the clack.types module.

  • BREAKING CHANGE: The names of many variables were changed (most of these variables now live in the new clack.types module).

Fixed

  • Fix the clack.Config class so it is now of type clack.types.ClackConfig.

0.2.9 - 2022-01-08

Fixed

  • Add AbstractConfig, Confit_T, and Config_T_co to API.

0.2.8 - 2022-01-08

Fixed

  • Add ‘path’ attribute to ConfigFile Protocol.

0.2.7 - 2022-01-08

Miscellaneous

  • Abstract away all YAML logic to ConfigFile Protocol.

0.2.6 - 2022-01-08

Added

  • Add clack.ConfigFile class (the new default for the --config option).

  • Add clack.pytest_plugin that includes make_config_file() fixture.

0.2.5 - 2022-01-08

Changed

  • Set the Config.config_file attribute for implicit config files too.

0.2.4 - 2022-01-08

Fixed

  • Fix bug with new --config CLI option parsing.

0.2.3 - 2022-01-08

Added

  • Add support for explicit config file locations via the new --config CLI option.

0.2.2 - 2022-01-06

Fixed

  • Allow clack.Config to have extra arguments.

0.2.1 - 2022-01-06

Fixed

  • Fix crash when Config defaults are not json-serializable.

0.2.0 - 2022-01-04

Added

  • Ability to load Config() class values from environment variables.

  • Ability to load Config() class values from YAML configuration files.

Changed

  • BREAKING CHANGE: The signature of the clack.main_factory() function has been changed.

Miscellaneous

  • Increased test coverage to >=80%.

0.1.3 - 2021-12-26

Added

  • Add comma_list_or_file class.

0.1.2 - 2021-12-25

Added

  • Add new clack.xdg module.

0.1.1 - 2021-12-24

Fixed

  • Fix type checking issue with clack.main_factory().

0.1.0 - 2021-12-23

Miscellaneous

  • Port clack library from (original) bugyi-lib library.

  • First release.