Changelog

Versions follow semver.

warning

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

[0.6.7]

Fixed

• bug

  Fixed Python 10 support.

[0.6.6]

Fixed

• bug

  Fixed reading toml config file with more keys than defined in the config class.

• bug

  Fixed default config property auto_environ to false.

[0.6.5]

Fixed

• bug

  Fix Toml dump config of type bool with a default and a comment with less than 40 characters. #22

• bug

  Fix Toml dump config of type str with no comment and no default. #23

• bug

  Use repr in case of error instead of __class__.__name__ which might exist if the given type is wrong.

[0.6.4]

Fixed

bug

Fix config nestable not updated from file.

[0.6.3]

Fixed

• bug

  Fix config type.

• construction

  Add KeyboardInterrupt event in case some resources need to be cleaned up.

• hammer

  Add global name argument to config property for use with auto global.

• construction

  Add raw_args to cli attributes.

• hammer

  Allow for start arguments to be a string command.

[0.6.2]

Fixed

• bug

  Fix config multi instance

[0.6.1]

Fixed

• bug

  Fix config order of reading (argument > code > file).

• bug

  Fix comment below variables in toml config format.

• bug

  Fix plugin registration for running loops instantiation.

• bug

  Fix config_class instantiation

• bug

  Fix config from cli arguments with default value.

• bug

  Fix toml null values.

[0.6.0]

Added

• sparkles

  Add TOML config format.

Changed

• hammer

  Change default config format to TOML.

• bug

  Change config_format to property auto updating serializer.

[0.5.1]

Fixed

• hammer

  Removed star imports.

[0.5.0]

Changed

• hammer

  Allow configs to be set on the instance.

• hammer

  Add print_version option.

Added

• sparkles

  Add services to run alongside applications and commands.

• sparkles

  Add plugin system.

[0.4.0]

Changed

• construction

  Executor default to ThreadPoolExecutor.

• construction

  Export AsyncExecutor.

Added

• sparkles

  Add Executor wraps

• construction

  Add Executor max workers argument

• sparkles

  Add Event & Dispatcher

• sparkles

  Add cli events.

[0.3.1]

Fixed

• bug

  Fix multiple logging handlers registered during tests.

• construction

  Add options for configuring the logger.

[0.3.0]

Changed

• feet

  Moved console related functions to console package.

• feet

  Moved keyhandler to console package.

Added

• sparkles

  console.progress_bar

• sparkles

  Add auto arguments from command functions.

• sparkles

  Add auto global argument for config.

• construction

  Add symbols argument to console.spinner

Fixed

• bug

  Config get_root return self if root.

[0.2.1]

Fixed

• hammer

  Allow config instance to be set directly.

• hammer

  Add root config class docstring as the first config comment.

[0.2.0]

Changed

• boom

  Rename CliApp -> Precept.

• hocho

  Removed old ConfigProp.

• hocho

  Removed Precept.configs, now Precept.config with new config api.

Added

• sparkles

  Command help from docstring.

• construction

  Add help formatter argument.

• sparkles

  Nested commands support, wrap a class into a Command.

• sparkles

  Config class

  • Comment support

  • Ini/yaml/json format choices

  • value from environ

  • nestable config attribute lookup

  • config factory.

• construction

  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