rich-click 1.9.0.dev0__tar.gz → 1.9.0.dev2__tar.gz

{rich_click-1.9.0.dev0/src/rich_click.egg-info → rich_click-1.9.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rich-click
-Version: 1.9.0.dev0
+Version: 1.9.0.dev2
 Summary: Format click help output nicely with rich
 Author-email: Phil Ewels <phil@ewels.co.uk>
 Maintainer-email: Phil Ewels <phil@ewels.co.uk>, Daniel Reeves <xdanielreeves@gmail.com>
@@ -64,7 +64,7 @@ Requires-Dist: mike>=2.1.3; extra == "docs"
 Requires-Dist: mkdocs[docs]>=1.6.1; extra == "docs"
 Requires-Dist: mkdocs-github-admonitions-plugin>=0.1.1; extra == "docs"
 Requires-Dist: mkdocs-glightbox>=0.4; extra == "docs"
-Requires-Dist: mkdocs-include-markdown-plugin>=7.1.6; python_version >= "3.9" and extra == "docs"
+Requires-Dist: mkdocs-include-markdown-plugin>=7.1.7; python_version >= "3.9" and extra == "docs"
 Requires-Dist: mkdocs-material[imaging]~=9.5.18; extra == "docs"
 Requires-Dist: mkdocs-material-extensions>=1.3.1; extra == "docs"
 Requires-Dist: mkdocs-rss-plugin>=1.15; extra == "docs"
@@ -95,7 +95,8 @@ Dynamic: license-file
 
 ---
 
-**rich-click** is a shim around [Click](https://click.palletsprojects.com/) that renders help output nicely using [Rich](https://github.com/Textualize/rich).
+<!--include-start-->
+**rich-click** is a wrapper around [Click](https://click.palletsprojects.com/) that renders help output nicely using [Rich](https://github.com/Textualize/rich).
 
 - Click is a _"Python package for creating beautiful command line interfaces"_.
 - Rich is a _"Python library for rich text and beautiful formatting in the terminal"_.
@@ -107,13 +108,13 @@ Click, formatted with Rich, with minimal customization required.
 
 - 🌈 Rich command-line formatting of click help and error messages
 - 😌 Same API as Click: usage is simply `import rich_click as click`
-- 💫 Nice styles by default
+- 🎨 Over 100 themes that can be set by developers and end-users (`export RICH_CLICK_THEME=...`)
 - 💻 CLI tool to run on _other people's_ tools (prefix the command with `rich-click`)
 - 📦 Export help text as HTML or SVG
 - 🎁 Group commands and options into named panels
 - ❌ Well formatted error messages
-- 🔢 Easily give custom sort order for options and commands
-- 🎨 Extensive customization of styling and behaviour possible
+- 💫 Extensive customization
+- 🤖 IDE autocomplete of Click decorators for smooth developer experience.
 
 ## Installation
 
@@ -121,8 +122,6 @@ Click, formatted with Rich, with minimal customization required.
 pip install rich-click
 ```
 
-[Read the docs](https://ewels.github.io/rich-click#installation) for all supported installation methods.
-
 ## Examples
 
 ### Simple Example
@@ -150,7 +149,11 @@ _Screenshot from [`examples/11_hello.py`](examples/11_hello.py)_
 
 ### More complex example
 
-![`python examples/03_groups_sorting.py`](docs/images/command_groups.svg)
+**rich-click** has a ton of customization options that let you compose help text however you'd like.
+
+Below is a more complex example of what **rich-click** is capable of, utilizing **themes** and **panels**:
+
+![`python examples/03_groups_sorting.py --help`](docs/images/command_groups.svg)
 
 _Screenshot from [`examples/03_groups_sorting.py`](examples/03_groups_sorting.py)_
 

{rich_click-1.9.0.dev0 → rich_click-1.9.0.dev2}/README.md

@@ -21,7 +21,8 @@
 
 ---
 
-**rich-click** is a shim around [Click](https://click.palletsprojects.com/) that renders help output nicely using [Rich](https://github.com/Textualize/rich).
+<!--include-start-->
+**rich-click** is a wrapper around [Click](https://click.palletsprojects.com/) that renders help output nicely using [Rich](https://github.com/Textualize/rich).
 
 - Click is a _"Python package for creating beautiful command line interfaces"_.
 - Rich is a _"Python library for rich text and beautiful formatting in the terminal"_.
@@ -33,13 +34,13 @@ Click, formatted with Rich, with minimal customization required.
 
 - 🌈 Rich command-line formatting of click help and error messages
 - 😌 Same API as Click: usage is simply `import rich_click as click`
-- 💫 Nice styles by default
+- 🎨 Over 100 themes that can be set by developers and end-users (`export RICH_CLICK_THEME=...`)
 - 💻 CLI tool to run on _other people's_ tools (prefix the command with `rich-click`)
 - 📦 Export help text as HTML or SVG
 - 🎁 Group commands and options into named panels
 - ❌ Well formatted error messages
-- 🔢 Easily give custom sort order for options and commands
-- 🎨 Extensive customization of styling and behaviour possible
+- 💫 Extensive customization
+- 🤖 IDE autocomplete of Click decorators for smooth developer experience.
 
 ## Installation
 
@@ -47,8 +48,6 @@ Click, formatted with Rich, with minimal customization required.
 pip install rich-click
 ```
 
-[Read the docs](https://ewels.github.io/rich-click#installation) for all supported installation methods.
-
 ## Examples
 
 ### Simple Example
@@ -76,7 +75,11 @@ _Screenshot from [`examples/11_hello.py`](examples/11_hello.py)_
 
 ### More complex example
 
-![`python examples/03_groups_sorting.py`](docs/images/command_groups.svg)
+**rich-click** has a ton of customization options that let you compose help text however you'd like.
+
+Below is a more complex example of what **rich-click** is capable of, utilizing **themes** and **panels**:
+
+![`python examples/03_groups_sorting.py --help`](docs/images/command_groups.svg)
 
 _Screenshot from [`examples/03_groups_sorting.py`](examples/03_groups_sorting.py)_
 

{rich_click-1.9.0.dev0 → rich_click-1.9.0.dev2}/pyproject.toml

@@ -54,7 +54,7 @@ optional-dependencies.docs = [
     "mkdocs[docs]>=1.6.1",
     "mkdocs-github-admonitions-plugin>=0.1.1",
     "mkdocs-glightbox>=0.4",
-    "mkdocs-include-markdown-plugin>=7.1.6; python_version>='3.9'",
+    "mkdocs-include-markdown-plugin>=7.1.7; python_version>='3.9'",
     "mkdocs-material[imaging]~=9.5.18",
     "mkdocs-material-extensions>=1.3.1",
     "mkdocs-rss-plugin>=1.15",
@@ -115,7 +115,7 @@ lint.isort.lines-after-imports = 2
 indent = 4
 
 [tool.pytest.ini_options]
-addopts = "-s -rP -vv --showlocals --cov --cov-report term"
+addopts = "-s -rP -v --showlocals --cov --cov-report term"
 pythonpath = [ "tests", "src" ]
 testpaths = [ "tests" ]
 
@@ -123,6 +123,7 @@ testpaths = [ "tests" ]
 python_version = "3.8"
 scripts_are_modules = true
 strict = true
+follow_imports = true
 exclude = [
     '.*?live_style_editor\.py$',
 ]

{rich_click-1.9.0.dev0 → rich_click-1.9.0.dev2}/src/rich_click/__init__.py

@@ -8,7 +8,7 @@ customization required.
 from __future__ import annotations
 
 
-__version__ = "1.9.0.dev0"
+__version__ = "1.9.0.dev2"
 
 # Import the entire click API here.
 # We need to manually import these instead of `from click import *` to force
@@ -85,6 +85,9 @@ from rich_click.rich_context import RichContext as RichContext
 from rich_click.rich_context import get_current_context as get_current_context
 from rich_click.rich_help_configuration import RichHelpConfiguration as RichHelpConfiguration
 from rich_click.rich_help_formatter import RichHelpFormatter as RichHelpFormatter
+from rich_click.rich_panel import RichCommandPanel as RichCommandPanel
+from rich_click.rich_panel import RichOptionPanel as RichOptionPanel
+from rich_click.rich_panel import RichPanel as RichPanel
 from rich_click.rich_parameter import RichArgument as RichArgument
 from rich_click.rich_parameter import RichOption as RichOption
 from rich_click.rich_parameter import RichParameter as RichParameter

{rich_click-1.9.0.dev0 → rich_click-1.9.0.dev2}/src/rich_click/_compat_click.py

@@ -16,9 +16,9 @@ except Exception:
     CLICK_IS_BEFORE_VERSION_9X = False
     CLICK_IS_VERSION_80 = False
 else:
-    _major = int(click_version.split(".")[0])  # type: ignore[attr-defined]
-    _minor = int(click_version.split(".")[1])  # type: ignore[attr-defined]
-    _patch = int(click_version.split(".")[2])  # type: ignore[attr-defined]
+    _major = int(click_version.split(".")[0])  # type: ignore[attr-defined,unused-ignore]
+    _minor = int(click_version.split(".")[1])  # type: ignore[attr-defined,unused-ignore]
+    _patch = int(click_version.split(".")[2])  # type: ignore[attr-defined,unused-ignore]
 
     CLICK_IS_BEFORE_VERSION_821 = (_major, _minor, _patch) < (8, 2, 1)
     CLICK_IS_BEFORE_VERSION_82 = (_major, _minor) < (8, 2)