Skip to content

Latest commit

 

History

History
173 lines (123 loc) · 4.62 KB

CHANGELOG.md

File metadata and controls

173 lines (123 loc) · 4.62 KB
Raw

Changelog

Versions follow semver.

⚠️ Expect breaking changes between minor versions prior to 1.0.0 while the api stabilize.

[0.6.7]

Fixed

  • 🐛 Fixed Python 10 support.

[0.6.6]

Fixed

  • 🐛 Fixed reading toml config file with more keys than defined in the config class.
  • 🐛 Fixed default config property auto_environ to false.

[0.6.5]

Fixed

  • 🐛 Fix Toml dump config of type bool with a default and a comment with less than 40 characters. #22
  • 🐛 Fix Toml dump config of type str with no comment and no default. #23
  • 🐛 Use repr in case of error instead of __class__.__name__ which might exist if the given type is wrong.

[0.6.4]

Fixed

🐛 Fix config nestable not updated from file.

[0.6.3]

Fixed

  • 🐛 Fix config type.
  • 🚧 Add KeyboardInterrupt event in case some resources need to be cleaned up.
  • 🔨 Add global name argument to config property for use with auto global.
  • 🚧 Add raw_args to cli attributes.
  • 🔨 Allow for start arguments to be a string command.

[0.6.2]

Fixed

  • 🐛 Fix config multi instance

[0.6.1]

Fixed

  • 🐛 Fix config order of reading (argument > code > file).
  • 🐛 Fix comment below variables in toml config format.
  • 🐛 Fix plugin registration for running loops instantiation.
  • 🐛 Fix config_class instantiation
  • 🐛 Fix config from cli arguments with default value.
  • 🐛 Fix toml null values.

[0.6.0]

Added

  • ✨ Add TOML config format.

Changed

  • 🔨 Change default config format to TOML.
  • 🐛 Change config_format to property auto updating serializer.

[0.5.1]

Fixed

  • 🔨 Removed star imports.

[0.5.0]

Changed

  • 🔨 Allow configs to be set on the instance.
  • 🔨 Add print_version option.

Added

  • ✨ Add services to run alongside applications and commands.
  • ✨ Add plugin system.

[0.4.0]

Changed

  • 🚧 Executor default to ThreadPoolExecutor.
  • 🚧 Export AsyncExecutor.

Added

  • ✨ Add Executor wraps
  • 🚧 Add Executor max workers argument
  • ✨ Add Event & Dispatcher
  • ✨ Add cli events.

[0.3.1]

Fixed

  • 🐛 Fix multiple logging handlers registered during tests.
  • 🚧 Add options for configuring the logger.

[0.3.0]

Changed

  • 🐾 Moved console related functions to console package.
  • 🐾 Moved keyhandler to console package.

Added

  • ✨ console.progress_bar
  • ✨ Add auto arguments from command functions.
  • ✨ Add auto global argument for config.
  • 🚧 Add symbols argument to console.spinner

Fixed

  • 🐛 Config get_root return self if root.

[0.2.1]

Fixed

  • 🔨 Allow config instance to be set directly.
  • 🔨 Add root config class docstring as the first config comment.

[0.2.0]

Changed

  • 💥 Rename CliApp -> Precept.
  • 🔪 Removed old ConfigProp.
  • 🔪 Removed Precept.configs, now Precept.config with new config api.

Added

  • ✨ Command help from docstring.
  • 🚧 Add help formatter argument.
  • ✨ Nested commands support, wrap a class into a Command.
  • ✨ Config class
    • Comment support
    • Ini/yaml/json format choices
    • value from environ
    • nestable config attribute lookup
    • config factory.
  • 🚧 Errors classes: PreceptError, ConfigError, ImmutableError

[0.1.1]

Fixed

  • KeyHandler fixes:
    • Remove no handler print.
    • Add Keys class with most specials keys.
    • Handle ctrl-c by default.
  • Fix single argument casing (auto convert to snake_case).

[0.1.0]

Added

  • Added global --log-file option
  • Added execute_with_lock to AsyncExecutor (CliApp.executor)
  • Added add_dump_config_command, adds prog dump-config outfile command to output the currently used config file.
  • Added ImmutableDict, immutable mapping with auto attribute lookup from __init__ arguments.
  • Added goto_xy, getch.
  • Added KeyHandler, reads each sys.stdin keys as they come and apply a function according to the key.

Changed

  • Default main command on CliApp now async.
  • Removed _ prefix from prog_name, global_arguments, default_configs, version.
  • Argument and configs are now ImmutableDict.
  • Removed kwargs from Argument, all parser.add_argument parameters now available as key argument.
  • config_file can be a list of paths to check for existence in order.

[0.0.2]

Fixed

  • Added help to Command
  • Set spinner default background to None

[0.0.1]

  • Initial release