Script 'mail_helper' called by obssrc
Hello community,
here is the log from the commit of package python-rich-click for
openSUSE:Factory checked in at 2022-12-15 19:24:48
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-rich-click (Old)
and /work/SRC/openSUSE:Factory/.python-rich-click.new.1835 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-rich-click"
Thu Dec 15 19:24:48 2022 rev:2 rq:1042866 version:1.6.0
Changes:
--------
--- /work/SRC/openSUSE:Factory/python-rich-click/python-rich-click.changes
2022-09-01 22:12:24.448447023 +0200
+++
/work/SRC/openSUSE:Factory/.python-rich-click.new.1835/python-rich-click.changes
2022-12-15 19:24:57.047969460 +0100
@@ -1,0 +2,9 @@
+Tue Dec 13 17:00:23 UTC 2022 - Yogalakshmi Arunachalam <[email protected]>
+
+- Update to version 1.6.0
+ * warning Removed support for Typer warning
+ * Please use the native Typer functionality instead.
+ * Added self-updating automated readme screengrabs using rich-codex
+ * Fix AssertionError when using click command call #94
+
+-------------------------------------------------------------------
Old:
----
rich-click-1.5.2.tar.gz
New:
----
rich-click-1.6.0.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-rich-click.spec ++++++
--- /var/tmp/diff_new_pack.NLlwSY/_old 2022-12-15 19:24:57.787973670 +0100
+++ /var/tmp/diff_new_pack.NLlwSY/_new 2022-12-15 19:24:57.791973693 +0100
@@ -18,7 +18,7 @@
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
Name: python-rich-click
-Version: 1.5.2
+Version: 1.6.0
Release: 0
Summary: Format click help output nicely with rich
License: MIT
++++++ rich-click-1.5.2.tar.gz -> rich-click-1.6.0.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/PKG-INFO
new/rich-click-1.6.0/PKG-INFO
--- old/rich-click-1.5.2/PKG-INFO 2022-08-02 00:13:53.257295100 +0200
+++ new/rich-click-1.6.0/PKG-INFO 2022-12-05 09:44:27.947018100 +0100
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: rich-click
-Version: 1.5.2
+Version: 1.6.0
Summary: Format click help output nicely with rich
Home-page: https://github.com/ewels/rich-click
Author: Phil Ewels
@@ -18,7 +18,6 @@
Classifier: Programming Language :: Python
Requires-Python: >=3.7
Description-Content-Type: text/markdown
-Provides-Extra: typer
Provides-Extra: dev
License-File: LICENSE
@@ -42,9 +41,9 @@
- ð¢ Easily give custom sort order for options and commands
- ð¨ Extensive customisation of styling and behaviour possible
-
+
-_Screenshot from
[`examples/click/03_groups_sorting.py`](examples/click/03_groups_sorting.py)_
+_Screenshot from
[`examples/03_groups_sorting.py`](examples/03_groups_sorting.py)_
## Installation
@@ -67,6 +66,8 @@
sudo port install py-rich-click
```
+Note that rich-click requires `click>=7` but formatted subcommands (groups)
only work with `click>=8`. With v7 the output simply reverts to default click
output.
+
## Usage
### Import as click
@@ -79,7 +80,7 @@
That's it ⨠Then continue to use `click` as you would normally.
-> See [`examples/click/01_simple.py`](examples/click/01_simple.py) for an
example.
+> See [`examples/01_simple.py`](examples/01_simple.py) for an example.
The intention is to maintain most / all of the normal click functionality and
arguments.
If you spot something that breaks or is missing once you start using the
plugin, please create an issue about it.
@@ -89,28 +90,7 @@
If you prefer, you can `RichGroup` or `RichCommand` with the `cls` argument in
your click usage instead.
This means that you can continue to use the unmodified `click` package in
parallel.
-> See [`examples/click/02_declarative.py`](examples/click/02_declarative.py)
for an example.
-
-### Typer support
-
-[`Typer`](https://github.com/tiangolo/typer) is also supported.
-You need to use rich-click with the `typer`
[extra](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-setuptools-extras)
in your package requirements: `rich-click[typer]`
-
-For example, to install locally:
-
-```bash
-python -m pip install rich-click[typer]
-```
-
-Then just replace your usual `typer` import by:
-
-```python
-import rich_click.typer as typer
-```
-
-That's it ⨠All the usual `typer` API should be available.
-
-> See [`examples/typer/`](examples/typer/) for some example scripts.
+> See [`examples/02_declarative.py`](examples/02_declarative.py) for an
example.
### Command-line usage
@@ -169,6 +149,8 @@
Note that most normal click options should still work, such as
`show_default=True`, `required=True` and `hidden=True`.
+> Note: All images below are auto-generated using another side-project of
mine: [rich-codex](https://github.com/ewels/rich-codex). Pretty cool!
+
### Using rich markup
In order to be as widely compatible as possible with a simple import,
rich-click does _not_ parse rich formatting markup (eg. `[red]`) by default.
You need to opt-in to this behaviour.
@@ -182,9 +164,9 @@
Remember that you'll need to escape any regular square brackets using a back
slash in your help texts,
for example: `[dim]\[my-default: foo][\]`
-
+
-> See [`examples/click/04_rich_markup.py`](examples/click/04_rich_markup.py)
for and example.
+> See [`examples/04_rich_markup.py`](examples/04_rich_markup.py) for an
example.
### Using Markdown
@@ -195,9 +177,9 @@
click.rich_click.USE_MARKDOWN = True
```
-
+
-> See [`examples/click/05_markdown.py`](examples/click/05_markdown.py) for an
example.
+> See [`examples/05_markdown.py`](examples/05_markdown.py) for an example.
### Positional arguments
@@ -212,9 +194,9 @@
click.rich_click.GROUP_ARGUMENTS_OPTIONS = True
```
-
+
-> See [`examples/click/06_arguments.py`](examples/click/06_arguments.py) for
an example.
+> See [`examples/06_arguments.py`](examples/06_arguments.py) for an example.
### Metavars and option choices
@@ -225,7 +207,7 @@
By default, rich-click shows metavars in their own column.
However, if you have a long list of choices, this column can be quite wide and
result in a lot of white space:
-
+
It may look better to show metavars appended to the help text, instead of in
their own column.
For this, use the following:
@@ -235,28 +217,30 @@
click.rich_click.APPEND_METAVARS_HELP = True
```
-
+
-> See [`examples/click/08_metavars.py`](examples/click/08_metavars.py) for an
example.
+> See [`examples/08_metavars.py`](examples/08_metavars.py) for an example.
### Error messages
By default, rich-click gives some nice formatting to error messages:
-
+
You can customise the _Try 'command --help' for help._ message with
`ERRORS_SUGGESTION`
using rich-click though, and add some text after the error with
`ERRORS_EPILOGUE`.
-For example, from
[`examples/click/07_custom_errors.py`](examples/click/07_custom_errors.py):
+For example, from
[`examples/07_custom_errors.py`](examples/07_custom_errors.py):
```python
-click.rich_click.STYLE_ERRORS_SUGGESTION = "blue italic"
+click.rich_click.STYLE_ERRORS_SUGGESTION = "magenta italic"
click.rich_click.ERRORS_SUGGESTION = "Try running the '--help' flag for more
information."
-click.rich_click.ERRORS_EPILOGUE = "To find out more, visit https://mytool.com";
+click.rich_click.ERRORS_EPILOGUE = "To find out more, visit
[link=https://mytool.com]https://mytool.com[/link]";
```
-
+
+
+> See [`examples/07_custom_errors.py`](examples/07_custom_errors.py) for an
example.
### Help width
@@ -288,9 +272,14 @@
You can make some really ~horrible~ _colourful_ solutions using these styles
if you wish:
-
+<!-- RICH-CODEX
+extra_env:
+ TERMINAL_WIDTH: 160
+-->
+
+
-> See [`examples/click/10_table_styles.py`](examples/click/10_table_styles.py)
for and example.
+> See [`examples/10_table_styles.py`](examples/10_table_styles.py) for an
example.
See the [_Configuration options_](#configuration-options) section below for
the full list of available options.
@@ -302,9 +291,9 @@
- For options (flags), set `click.rich_click.OPTION_GROUPS`
- For subcommands (groups), set `click.rich_click.COMMAND_GROUPS`
-
+
-See
[`examples/click/03_groups_sorting.py`](examples/click/03_groups_sorting.py)
for a full example.
+> See [`examples/03_groups_sorting.py`](examples/03_groups_sorting.py) for a
full example.
### Options
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/README.md
new/rich-click-1.6.0/README.md
--- old/rich-click-1.5.2/README.md 2022-08-02 00:13:40.000000000 +0200
+++ new/rich-click-1.6.0/README.md 2022-12-05 09:44:12.000000000 +0100
@@ -18,9 +18,9 @@
- ð¢ Easily give custom sort order for options and commands
- ð¨ Extensive customisation of styling and behaviour possible
-
+
-_Screenshot from
[`examples/click/03_groups_sorting.py`](examples/click/03_groups_sorting.py)_
+_Screenshot from
[`examples/03_groups_sorting.py`](examples/03_groups_sorting.py)_
## Installation
@@ -43,6 +43,8 @@
sudo port install py-rich-click
```
+Note that rich-click requires `click>=7` but formatted subcommands (groups)
only work with `click>=8`. With v7 the output simply reverts to default click
output.
+
## Usage
### Import as click
@@ -55,7 +57,7 @@
That's it ⨠Then continue to use `click` as you would normally.
-> See [`examples/click/01_simple.py`](examples/click/01_simple.py) for an
example.
+> See [`examples/01_simple.py`](examples/01_simple.py) for an example.
The intention is to maintain most / all of the normal click functionality and
arguments.
If you spot something that breaks or is missing once you start using the
plugin, please create an issue about it.
@@ -65,28 +67,7 @@
If you prefer, you can `RichGroup` or `RichCommand` with the `cls` argument in
your click usage instead.
This means that you can continue to use the unmodified `click` package in
parallel.
-> See [`examples/click/02_declarative.py`](examples/click/02_declarative.py)
for an example.
-
-### Typer support
-
-[`Typer`](https://github.com/tiangolo/typer) is also supported.
-You need to use rich-click with the `typer`
[extra](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-setuptools-extras)
in your package requirements: `rich-click[typer]`
-
-For example, to install locally:
-
-```bash
-python -m pip install rich-click[typer]
-```
-
-Then just replace your usual `typer` import by:
-
-```python
-import rich_click.typer as typer
-```
-
-That's it ⨠All the usual `typer` API should be available.
-
-> See [`examples/typer/`](examples/typer/) for some example scripts.
+> See [`examples/02_declarative.py`](examples/02_declarative.py) for an
example.
### Command-line usage
@@ -145,6 +126,8 @@
Note that most normal click options should still work, such as
`show_default=True`, `required=True` and `hidden=True`.
+> Note: All images below are auto-generated using another side-project of
mine: [rich-codex](https://github.com/ewels/rich-codex). Pretty cool!
+
### Using rich markup
In order to be as widely compatible as possible with a simple import,
rich-click does _not_ parse rich formatting markup (eg. `[red]`) by default.
You need to opt-in to this behaviour.
@@ -158,9 +141,9 @@
Remember that you'll need to escape any regular square brackets using a back
slash in your help texts,
for example: `[dim]\[my-default: foo][\]`
-
+
-> See [`examples/click/04_rich_markup.py`](examples/click/04_rich_markup.py)
for and example.
+> See [`examples/04_rich_markup.py`](examples/04_rich_markup.py) for an
example.
### Using Markdown
@@ -171,9 +154,9 @@
click.rich_click.USE_MARKDOWN = True
```
-
+
-> See [`examples/click/05_markdown.py`](examples/click/05_markdown.py) for an
example.
+> See [`examples/05_markdown.py`](examples/05_markdown.py) for an example.
### Positional arguments
@@ -188,9 +171,9 @@
click.rich_click.GROUP_ARGUMENTS_OPTIONS = True
```
-
+
-> See [`examples/click/06_arguments.py`](examples/click/06_arguments.py) for
an example.
+> See [`examples/06_arguments.py`](examples/06_arguments.py) for an example.
### Metavars and option choices
@@ -201,7 +184,7 @@
By default, rich-click shows metavars in their own column.
However, if you have a long list of choices, this column can be quite wide and
result in a lot of white space:
-
+
It may look better to show metavars appended to the help text, instead of in
their own column.
For this, use the following:
@@ -211,28 +194,30 @@
click.rich_click.APPEND_METAVARS_HELP = True
```
-
+
-> See [`examples/click/08_metavars.py`](examples/click/08_metavars.py) for an
example.
+> See [`examples/08_metavars.py`](examples/08_metavars.py) for an example.
### Error messages
By default, rich-click gives some nice formatting to error messages:
-
+
You can customise the _Try 'command --help' for help._ message with
`ERRORS_SUGGESTION`
using rich-click though, and add some text after the error with
`ERRORS_EPILOGUE`.
-For example, from
[`examples/click/07_custom_errors.py`](examples/click/07_custom_errors.py):
+For example, from
[`examples/07_custom_errors.py`](examples/07_custom_errors.py):
```python
-click.rich_click.STYLE_ERRORS_SUGGESTION = "blue italic"
+click.rich_click.STYLE_ERRORS_SUGGESTION = "magenta italic"
click.rich_click.ERRORS_SUGGESTION = "Try running the '--help' flag for more
information."
-click.rich_click.ERRORS_EPILOGUE = "To find out more, visit https://mytool.com";
+click.rich_click.ERRORS_EPILOGUE = "To find out more, visit
[link=https://mytool.com]https://mytool.com[/link]";
```
-
+
+
+> See [`examples/07_custom_errors.py`](examples/07_custom_errors.py) for an
example.
### Help width
@@ -264,9 +249,14 @@
You can make some really ~horrible~ _colourful_ solutions using these styles
if you wish:
-
+<!-- RICH-CODEX
+extra_env:
+ TERMINAL_WIDTH: 160
+-->
+
+
-> See [`examples/click/10_table_styles.py`](examples/click/10_table_styles.py)
for and example.
+> See [`examples/10_table_styles.py`](examples/10_table_styles.py) for an
example.
See the [_Configuration options_](#configuration-options) section below for
the full list of available options.
@@ -278,9 +268,9 @@
- For options (flags), set `click.rich_click.OPTION_GROUPS`
- For subcommands (groups), set `click.rich_click.COMMAND_GROUPS`
-
+
-See
[`examples/click/03_groups_sorting.py`](examples/click/03_groups_sorting.py)
for a full example.
+> See [`examples/03_groups_sorting.py`](examples/03_groups_sorting.py) for a
full example.
### Options
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/setup.py
new/rich-click-1.6.0/setup.py
--- old/rich-click-1.5.2/setup.py 2022-08-02 00:13:40.000000000 +0200
+++ new/rich-click-1.6.0/setup.py 2022-12-05 09:44:12.000000000 +0100
@@ -7,7 +7,6 @@
"importlib-metadata; python_version < '3.8'",
],
extras_require={
- "typer": "typer>=0.4,<0.6",
"dev": "pre-commit",
},
)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/src/rich_click/__init__.py
new/rich-click-1.6.0/src/rich_click/__init__.py
--- old/rich-click-1.5.2/src/rich_click/__init__.py 2022-08-02
00:13:40.000000000 +0200
+++ new/rich-click-1.6.0/src/rich_click/__init__.py 2022-12-05
09:44:12.000000000 +0100
@@ -5,7 +5,7 @@
customisation required.
"""
-__version__ = "1.5.2"
+__version__ = "1.6.0"
from typing import TYPE_CHECKING
@@ -44,10 +44,13 @@
return click_group(*args, cls=cls, **kwargs)
-def command(*args, cls=RichCommand, **kwargs):
+def command(name=None, cls=RichCommand, **attrs):
"""
Command decorator function.
Defines the command() function so that it uses the RichCommand class by
default.
"""
- return click_command(*args, cls=cls, **kwargs)
+ if callable(name) and cls:
+ return click_command(cls=cls, **attrs)(name)
+
+ return click_command(name, cls=cls, **attrs)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/src/rich_click/rich_click.py
new/rich-click-1.6.0/src/rich_click/rich_click.py
--- old/rich-click-1.5.2/src/rich_click/rich_click.py 2022-08-02
00:13:40.000000000 +0200
+++ new/rich-click-1.6.0/src/rich_click/rich_click.py 2022-12-05
09:44:12.000000000 +0100
@@ -613,31 +613,43 @@
"""
console = _get_rich_console()
if getattr(self, "ctx", None) is not None:
- console.print(self.ctx.get_usage())
+ console.print(Padding(self.ctx.get_usage(), 1))
if ERRORS_SUGGESTION:
- console.print(ERRORS_SUGGESTION, style=STYLE_ERRORS_SUGGESTION)
+ console.print(
+ Padding(
+ ERRORS_SUGGESTION,
+ (0, 1, 0, 1),
+ ),
+ style=STYLE_ERRORS_SUGGESTION,
+ )
elif (
ERRORS_SUGGESTION is None
and getattr(self, "ctx", None) is not None
and self.ctx.command.get_help_option(self.ctx) is not None
):
console.print(
- "Try [blue]'{command} {option}'[/] for help.".format(
- command=self.ctx.command_path,
option=self.ctx.help_option_names[0]
+ Padding(
+ "Try [blue]'{command} {option}'[/] for help.".format(
+ command=self.ctx.command_path,
option=self.ctx.help_option_names[0]
+ ),
+ (0, 1, 0, 1),
),
style=STYLE_ERRORS_SUGGESTION,
)
console.print(
- Panel(
- highlighter(self.format_message()),
- border_style=STYLE_ERRORS_PANEL_BORDER,
- title=ERRORS_PANEL_TITLE,
- title_align=ALIGN_ERRORS_PANEL,
+ Padding(
+ Panel(
+ highlighter(self.format_message()),
+ border_style=STYLE_ERRORS_PANEL_BORDER,
+ title=ERRORS_PANEL_TITLE,
+ title_align=ALIGN_ERRORS_PANEL,
+ ),
+ (0, 0, 1, 0),
)
)
if ERRORS_EPILOGUE:
- console.print(ERRORS_EPILOGUE)
+ console.print(Padding(ERRORS_EPILOGUE, (0, 1, 1, 1)))
def rich_abort_error() -> None:
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/src/rich_click/typer.py
new/rich-click-1.6.0/src/rich_click/typer.py
--- old/rich-click-1.5.2/src/rich_click/typer.py 2022-08-02
00:13:40.000000000 +0200
+++ new/rich-click-1.6.0/src/rich_click/typer.py 1970-01-01
01:00:00.000000000 +0100
@@ -1,37 +0,0 @@
-from typing import Any, Callable
-
-from typer import * # noqa
-from typer import Typer as BaseTyper
-from typer.models import CommandFunctionType
-
-from . import rich_click # noqa: F401
-
-from rich_click import RichCommand, RichGroup
-
-
-class Typer(BaseTyper):
- """A custom subclassed version of typer.Typer to allow rich help."""
-
- def __init__(
- self,
- *args,
- cls=RichGroup,
- **kwargs,
- ) -> None:
- """Initialise with a RichGroup class as the default."""
- super().__init__(*args, cls=cls, **kwargs)
-
- def command(
- self,
- *args,
- cls=RichCommand,
- **kwargs,
- ) -> Callable[[CommandFunctionType], CommandFunctionType]:
- return super().command(*args, cls=cls, **kwargs)
-
-
-def run(function: Callable[..., Any]) -> Any:
- """Redefine typer.run() to use our custom Typer class.""" # noqa D402
- app = Typer()
- app.command()(function)
- app()
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/src/rich_click.egg-info/PKG-INFO
new/rich-click-1.6.0/src/rich_click.egg-info/PKG-INFO
--- old/rich-click-1.5.2/src/rich_click.egg-info/PKG-INFO 2022-08-02
00:13:53.000000000 +0200
+++ new/rich-click-1.6.0/src/rich_click.egg-info/PKG-INFO 2022-12-05
09:44:27.000000000 +0100
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: rich-click
-Version: 1.5.2
+Version: 1.6.0
Summary: Format click help output nicely with rich
Home-page: https://github.com/ewels/rich-click
Author: Phil Ewels
@@ -18,7 +18,6 @@
Classifier: Programming Language :: Python
Requires-Python: >=3.7
Description-Content-Type: text/markdown
-Provides-Extra: typer
Provides-Extra: dev
License-File: LICENSE
@@ -42,9 +41,9 @@
- ð¢ Easily give custom sort order for options and commands
- ð¨ Extensive customisation of styling and behaviour possible
-
+
-_Screenshot from
[`examples/click/03_groups_sorting.py`](examples/click/03_groups_sorting.py)_
+_Screenshot from
[`examples/03_groups_sorting.py`](examples/03_groups_sorting.py)_
## Installation
@@ -67,6 +66,8 @@
sudo port install py-rich-click
```
+Note that rich-click requires `click>=7` but formatted subcommands (groups)
only work with `click>=8`. With v7 the output simply reverts to default click
output.
+
## Usage
### Import as click
@@ -79,7 +80,7 @@
That's it ⨠Then continue to use `click` as you would normally.
-> See [`examples/click/01_simple.py`](examples/click/01_simple.py) for an
example.
+> See [`examples/01_simple.py`](examples/01_simple.py) for an example.
The intention is to maintain most / all of the normal click functionality and
arguments.
If you spot something that breaks or is missing once you start using the
plugin, please create an issue about it.
@@ -89,28 +90,7 @@
If you prefer, you can `RichGroup` or `RichCommand` with the `cls` argument in
your click usage instead.
This means that you can continue to use the unmodified `click` package in
parallel.
-> See [`examples/click/02_declarative.py`](examples/click/02_declarative.py)
for an example.
-
-### Typer support
-
-[`Typer`](https://github.com/tiangolo/typer) is also supported.
-You need to use rich-click with the `typer`
[extra](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-setuptools-extras)
in your package requirements: `rich-click[typer]`
-
-For example, to install locally:
-
-```bash
-python -m pip install rich-click[typer]
-```
-
-Then just replace your usual `typer` import by:
-
-```python
-import rich_click.typer as typer
-```
-
-That's it ⨠All the usual `typer` API should be available.
-
-> See [`examples/typer/`](examples/typer/) for some example scripts.
+> See [`examples/02_declarative.py`](examples/02_declarative.py) for an
example.
### Command-line usage
@@ -169,6 +149,8 @@
Note that most normal click options should still work, such as
`show_default=True`, `required=True` and `hidden=True`.
+> Note: All images below are auto-generated using another side-project of
mine: [rich-codex](https://github.com/ewels/rich-codex). Pretty cool!
+
### Using rich markup
In order to be as widely compatible as possible with a simple import,
rich-click does _not_ parse rich formatting markup (eg. `[red]`) by default.
You need to opt-in to this behaviour.
@@ -182,9 +164,9 @@
Remember that you'll need to escape any regular square brackets using a back
slash in your help texts,
for example: `[dim]\[my-default: foo][\]`
-
+
-> See [`examples/click/04_rich_markup.py`](examples/click/04_rich_markup.py)
for and example.
+> See [`examples/04_rich_markup.py`](examples/04_rich_markup.py) for an
example.
### Using Markdown
@@ -195,9 +177,9 @@
click.rich_click.USE_MARKDOWN = True
```
-
+
-> See [`examples/click/05_markdown.py`](examples/click/05_markdown.py) for an
example.
+> See [`examples/05_markdown.py`](examples/05_markdown.py) for an example.
### Positional arguments
@@ -212,9 +194,9 @@
click.rich_click.GROUP_ARGUMENTS_OPTIONS = True
```
-
+
-> See [`examples/click/06_arguments.py`](examples/click/06_arguments.py) for
an example.
+> See [`examples/06_arguments.py`](examples/06_arguments.py) for an example.
### Metavars and option choices
@@ -225,7 +207,7 @@
By default, rich-click shows metavars in their own column.
However, if you have a long list of choices, this column can be quite wide and
result in a lot of white space:
-
+
It may look better to show metavars appended to the help text, instead of in
their own column.
For this, use the following:
@@ -235,28 +217,30 @@
click.rich_click.APPEND_METAVARS_HELP = True
```
-
+
-> See [`examples/click/08_metavars.py`](examples/click/08_metavars.py) for an
example.
+> See [`examples/08_metavars.py`](examples/08_metavars.py) for an example.
### Error messages
By default, rich-click gives some nice formatting to error messages:
-
+
You can customise the _Try 'command --help' for help._ message with
`ERRORS_SUGGESTION`
using rich-click though, and add some text after the error with
`ERRORS_EPILOGUE`.
-For example, from
[`examples/click/07_custom_errors.py`](examples/click/07_custom_errors.py):
+For example, from
[`examples/07_custom_errors.py`](examples/07_custom_errors.py):
```python
-click.rich_click.STYLE_ERRORS_SUGGESTION = "blue italic"
+click.rich_click.STYLE_ERRORS_SUGGESTION = "magenta italic"
click.rich_click.ERRORS_SUGGESTION = "Try running the '--help' flag for more
information."
-click.rich_click.ERRORS_EPILOGUE = "To find out more, visit https://mytool.com";
+click.rich_click.ERRORS_EPILOGUE = "To find out more, visit
[link=https://mytool.com]https://mytool.com[/link]";
```
-
+
+
+> See [`examples/07_custom_errors.py`](examples/07_custom_errors.py) for an
example.
### Help width
@@ -288,9 +272,14 @@
You can make some really ~horrible~ _colourful_ solutions using these styles
if you wish:
-
+<!-- RICH-CODEX
+extra_env:
+ TERMINAL_WIDTH: 160
+-->
+
+
-> See [`examples/click/10_table_styles.py`](examples/click/10_table_styles.py)
for and example.
+> See [`examples/10_table_styles.py`](examples/10_table_styles.py) for an
example.
See the [_Configuration options_](#configuration-options) section below for
the full list of available options.
@@ -302,9 +291,9 @@
- For options (flags), set `click.rich_click.OPTION_GROUPS`
- For subcommands (groups), set `click.rich_click.COMMAND_GROUPS`
-
+
-See
[`examples/click/03_groups_sorting.py`](examples/click/03_groups_sorting.py)
for a full example.
+> See [`examples/03_groups_sorting.py`](examples/03_groups_sorting.py) for a
full example.
### Options
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/rich-click-1.5.2/src/rich_click.egg-info/SOURCES.txt
new/rich-click-1.6.0/src/rich_click.egg-info/SOURCES.txt
--- old/rich-click-1.5.2/src/rich_click.egg-info/SOURCES.txt 2022-08-02
00:13:53.000000000 +0200
+++ new/rich-click-1.6.0/src/rich_click.egg-info/SOURCES.txt 2022-12-05
09:44:27.000000000 +0100
@@ -10,7 +10,6 @@
src/rich_click/rich_click.py
src/rich_click/rich_command.py
src/rich_click/rich_group.py
-src/rich_click/typer.py
src/rich_click.egg-info/PKG-INFO
src/rich_click.egg-info/SOURCES.txt
src/rich_click.egg-info/dependency_links.txt
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/rich-click-1.5.2/src/rich_click.egg-info/requires.txt
new/rich-click-1.6.0/src/rich_click.egg-info/requires.txt
--- old/rich-click-1.5.2/src/rich_click.egg-info/requires.txt 2022-08-02
00:13:53.000000000 +0200
+++ new/rich-click-1.6.0/src/rich_click.egg-info/requires.txt 2022-12-05
09:44:27.000000000 +0100
@@ -6,6 +6,3 @@
[dev]
pre-commit
-
-[typer]
-typer<0.6,>=0.4
