Clize Versions Save

What's Changed

• Improve error message when passing description= to run when not using multi-commands by @epsy in https://github.com/epsy/clize/pull/103

Full Changelog: https://github.com/epsy/clize/compare/v5.0.1...v5.0.2

What's Changed

• Fix using a dict in alt= parameter of clize.run by @epsy in https://github.com/epsy/clize/pull/102

Full Changelog: https://github.com/epsy/clize/compare/v5.0.0...v5.0.1

Breaking changes:

• bytes annotation (converter) now re-encodes the corresponding parameter back to bytes

Deprecations:

• The convert_default argument to value_converter is now deprecated. Parameter.cli_default is the recommended replacement. To help transition, a new convert_default_filter option has been added to value_converter, which allows converter authors to filter which values are selected for default conversion, thereby not incurring a deprecation warning for the user.

Updated compatibility:

• Dropped support for Python 2.7, Python 3.5.
• Verified support for Python 3.10+
• Compatibility with Docutils 0.21+
• Improved path support for Windows

Improvements:

• Automatically group identical subcommands as aliases
• Evaluate deferred annotations from PEP 563
• Basic support for typing.Annotated
• Parameter.cli_default allows script writers to specify a default value that will be converted like an argument passed in from the CLI, but not supplied when the function is called from Python.

Process updates:

• Updated Continuous Integration and Delivery to speed up releases and move off of deprecated CI platform.

PR list

• Pin coverage/coveralls version by @epsy in https://github.com/epsy/clize/pull/67
• Doc improvements, update sphinx to 4.2.0 by @epsy in https://github.com/epsy/clize/pull/68
• Automatically group identical subcommands as aliases by @epsy in https://github.com/epsy/clize/pull/69
• Fix readthedocs build by @epsy in https://github.com/epsy/clize/pull/70
• Add shared CI by @epsy in https://github.com/epsy/clize/pull/75
• drop Python 2 support, support Python 3.10 by @epsy in https://github.com/epsy/clize/pull/76
• Add continuous deployment and clean up a few files by @epsy in https://github.com/epsy/clize/pull/78
• Compatibility with Docutils 0.21+ by @epsy in https://github.com/epsy/clize/pull/81
• Use evaluated annotations from sigtools by @epsy in https://github.com/epsy/clize/pull/83
• Make more tests go through future.annotations path by @epsy in https://github.com/epsy/clize/pull/84
• Basic support for typing.Annotated by @epsy in https://github.com/epsy/clize/pull/85
• Add an example using typing.Annotated and test it by @epsy in https://github.com/epsy/clize/pull/86
• Fix typos by @kianmeng in https://github.com/epsy/clize/pull/80
• Update contributors by @epsy in https://github.com/epsy/clize/pull/87
• BREAKING: bytes annotation now re-encodes the corresponding parameter back to bytes by @epsy in https://github.com/epsy/clize/pull/89
• Remove Python 2 from docs by @epsy in https://github.com/epsy/clize/pull/90
• Add CI on Windows and fix tests, update path handling by @epsy in https://github.com/epsy/clize/pull/92
• Add Parameter.cli_default() to supply default values for CLI only, through converters by @epsy in https://github.com/epsy/clize/pull/93
• Add deprecation warnings for convert_default, handle edge case by @epsy in https://github.com/epsy/clize/pull/94
• update docs with cli_default by @epsy in https://github.com/epsy/clize/pull/95
• Keep compatibility in default value of value_converter by @epsy in https://github.com/epsy/clize/pull/96
• Prepare 5.0.0 release by @epsy in https://github.com/epsy/clize/pull/97

New Contributors

• @kianmeng made their first contribution in https://github.com/epsy/clize/pull/80

Full Changelog: https://github.com/epsy/clize/compare/v4.2.1...v5.0.0

What's Changed

• update docs with cli_default by @epsy in https://github.com/epsy/clize/pull/95
• Keep compatibility in default value of value_converter by @epsy in https://github.com/epsy/clize/pull/96

Full Changelog: https://github.com/epsy/clize/compare/v5.0.0b1...v5.0.0b2

What's Changed

• Add Parameter.cli_default() to supply default values for CLI only, through converters by @epsy in https://github.com/epsy/clize/pull/93
• Add deprecation warnings for convert_default, handle edge case by @epsy in https://github.com/epsy/clize/pull/94

Full Changelog: https://github.com/epsy/clize/compare/v5.0.0a4...v5.0.0b1

What's Changed

• Add CI on Windows and fix tests, update path handling by @epsy in https://github.com/epsy/clize/pull/92

Full Changelog: https://github.com/epsy/clize/compare/v5.0.0a3...v5.0.0a4

What's Changed

• BREAKING: bytes annotation now re-encodes the corresponding parameter back to bytes by @epsy in https://github.com/epsy/clize/pull/89
• Add an example using typing.Annotated and test it by @epsy in https://github.com/epsy/clize/pull/86
• Fix typos by @kianmeng in https://github.com/epsy/clize/pull/80
• Update contributors by @epsy in https://github.com/epsy/clize/pull/87
• Remove Python 2 from docs by @epsy in https://github.com/epsy/clize/pull/90

New Contributors

• @kianmeng made their first contribution in https://github.com/epsy/clize/pull/80

Full Changelog: https://github.com/epsy/clize/compare/v5.0.0a2...v5.0.0a3

What's Changed

• Make more tests go through future.annotations path by @epsy in https://github.com/epsy/clize/pull/84
• Basic support for typing.Annotated by @epsy in https://github.com/epsy/clize/pull/85

Full Changelog: https://github.com/epsy/clize/compare/v5.0.0a1...v5.0.0a2

What's Changed

• Pin coverage/coveralls version by @epsy in https://github.com/epsy/clize/pull/67
• Doc improvements, update sphinx to 4.2.0 by @epsy in https://github.com/epsy/clize/pull/68
• Automatically group identical subcommands as aliases by @epsy in https://github.com/epsy/clize/pull/69
• Fix readthedocs build by @epsy in https://github.com/epsy/clize/pull/70
• Add shared CI by @epsy in https://github.com/epsy/clize/pull/75
• drop Python 2 support, support Python 3.10 by @epsy in https://github.com/epsy/clize/pull/76
• Add continuous deployment and clean up a few files by @epsy in https://github.com/epsy/clize/pull/78
• Compatibility with Docutils 0.21+ by @epsy in https://github.com/epsy/clize/pull/81
• Use evaluated annotations from sigtools by @epsy in https://github.com/epsy/clize/pull/83

Full Changelog: https://github.com/epsy/clize/compare/v4.2.1...v5.0.0a1