Objective for 2.0 is to release in mid 2025. That's a very, very long time away!
This is a living document. Nothing here is guaranteed, everything is subject to change.
Deprecations
Hard + immediate deprecations
These things will not be supported going into 2.0.0.
These are easy enough to enforce at the package install level, so there is no real risk of users getting hurt by this.
Click 7 support will be dropped
Python 3.7 support will be dropped
Hard + delayed deprecations
These things will be available in 2.0.0, and phased out entirely into 2.1.0. Using these features will trigger a DeprecationWarning.
Logic: Many of these things are already deprecated, and switching off them is relatively easy for users. These are, however, breaking API changes, and we want to support them as long as possible.
These things will be available in all 2.x versions, and phased out entirely in a hypothetical 3.0 or 3.1 release, if rich-click ever gets there (who knows!). Using these features will trigger a DeprecationWarning.
Logic: Switching away from these features is potentially very tedious for users, so we want to give them as much time as possible to move away.
"command groups" and "command aliases" will go away and will be replaced with / renamed to "panels".
Features
I want to decouple style config and non-style config somehow.
"Styles" API: Easy configuration for styles, e.g. RichStyleConfiguration.build(primary="red", secondary="blue")
2.0 will likely be what comes after 1.9.
Objective for 2.0 is to release in mid 2025. That's a very, very long time away!
This is a living document. Nothing here is guaranteed, everything is subject to change.
Deprecations
Hard + immediate deprecations
These things will not be supported going into
2.0.0.These are easy enough to enforce at the package install level, so there is no real risk of users getting hurt by this.
Hard + delayed deprecations
These things will be available in
2.0.0, and phased out entirely into2.1.0. Using these features will trigger aDeprecationWarning.Logic: Many of these things are already deprecated, and switching off them is relatively easy for users. These are, however, breaking API changes, and we want to support them as long as possible.
rich_click.rich_group(userich_click.rich_commandinstead)use_markdown=Trueanduse_rich_markup=True(usetext_markup=...instead)get_module_help_configuration()OptionHighlighterrich_click.cli.patch()(userich_click.patch.patch()instead)Soft + delayed deprecations
These things will be available in all
2.xversions, and phased out entirely in a hypothetical3.0or3.1release, ifrich-clickever gets there (who knows!). Using these features will trigger aDeprecationWarning.Logic: Switching away from these features is potentially very tedious for users, so we want to give them as much time as possible to move away.
Features
RichStyleConfiguration.build(primary="red", secondary="blue")