🔀 Merge pull request #1 from davep/general-refresh

General refresh

Author: davep

ChangeLog.md

@@ -1,5 +1,12 @@
 # textual-mandelbrot ChangeLog
 
+## v0.8.0
+
+**Released: 2024-03-10**
+
+- Bumped minimum Textual version to v0.52.1.
+- Made the command palette commands appear when opening the command palette.
+
 ## v0.7.0
 
 **Released: 2024-01-07**

Makefile

@@ -75,7 +75,7 @@ spackage:			# Create a source package for the library
 	$(build) -s
 
 .PHONY: packagecheck
-packagecheck: package		# Check the packaging.
+packagecheck: package spackage		# Check the packaging.
 	$(twine) check dist/*
 
 .PHONY: testdist

Pipfile

@@ -9,12 +9,12 @@ textual-canvas = "*"
 black = "*"
 
 [dev-packages]
-pylint = "*"
 mypy = "*"
 twine = "*"
 black = "*"
 pre-commit = "*"
 build = "*"
+pylint = "*"
 
 [requires]
-python_version = "3.10"
+python_version = "3.12"

Pipfile.lock

@@ -12,12 +12,25 @@ terminal.
 
 ## Installing
 
+### pipx
+
 The package can be installed using [`pipx`](https://pypa.github.io/pipx/):
 
 ```sh
 $ pipx install textual-mandelbrot
 ```
 
+### Homebrew
+
+The package is available via Homebrew. Use the following commands to install:
+
+```sh
+$ brew tap davep/homebrew
+$ brew install textual-mandelbrot
+```
+
+## Running
+
 Once installed you should be able to run the command `mandelexp` and the
 application will run.
 

README.md

@@ -22,6 +22,7 @@ classifiers =
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
     Topic :: Terminals
     Topic :: Software Development :: Libraries
     Typing :: Typed
@@ -36,7 +37,7 @@ packages = find:
 platforms = any
 include_package_data = True
 install_requires =
-    textual>=0.47.1
+    textual>=0.52.1
     textual-canvas
 python_requires = >=3.8
 

setup.cfg

@@ -7,7 +7,7 @@
 __credits__ = ["Dave Pearson"]
 __maintainer__ = "Dave Pearson"
 __email__ = "davep@davep.org"
-__version__ = "0.7.0"
+__version__ = "0.8.0"
 __licence__ = "MIT"
 
 ##############################################################################

textual_mandelbrot/__init__.py

@@ -3,10 +3,12 @@
 ##############################################################################
 # Python imports.
 from functools import partial
+from typing import Callable, Iterator
 
 ##############################################################################
 # Textual imports.
-from textual.command import Hit, Hits, Provider
+from textual.color import Color
+from textual.command import DiscoveryHit, Hit, Hits, Provider
 
 ##############################################################################
 # Local imports.
@@ -18,43 +20,25 @@
 class MandelbrotCommands(Provider):
     """A source of command palette commands for the Mandelbrot widget."""
 
-    async def search(self, query: str) -> Hits:
-        """Handle a request to search for system commands that match the query.
-
-        Args:
-            user_input: The user input to be matched.
-
-        Yields:
-            Command hits for use in the command palette.
-        """
-
-        # Nothing in here makes sense if the user isn't current on a
-        # Mandelbrot set.
-        if not isinstance(self.focused, Mandelbrot):
-            return
-
-        # Get a fuzzy matcher for looking for hits.
-        matcher = self.matcher(query)
+    PREFIX = "Mandelbrot: "
+    """Prefix that is common to all the commands."""
 
-        # Give all commands a common prefix.
-        prefix = "Mandelbrot: "
-
-        # Spin out some commands for setting the colours.
+    @classmethod
+    def _colour_commands(cls) -> Iterator[tuple[str, Callable[[int, int], Color], str]]:
+        """The colour commands."""
         for colour, source in (
             ("default", default_map),
             ("blue/brown", blue_brown_map),
             ("green", shades_of_green),
         ):
-            colour = f"{prefix}Set the colour map to {colour} "
-            match = matcher.match(colour)
-            if match:
-                yield Hit(
-                    match,
-                    matcher.highlight(colour),
-                    partial(self.focused.set_colour_source, source),
-                    help=f"Set the Mandelbrot colour palette to {colour}",
-                )
+            yield (
+                f"{cls.PREFIX}Set the colour map to {colour} ",
+                source,
+                f"Set the Mandelbrot colour palette to {colour}",
+            )
 
+    @classmethod
+    def _action_commands(cls) -> Iterator[tuple[str, str, str]]:
         # Spin out some commands based around available actions.
         for command, action, help_text in (
             (
@@ -92,7 +76,69 @@ async def search(self, query: str) -> Hits:
                 "Remove detail from the Mandelbrot set (will run faster)",
             ),
         ):
-            command = f"{prefix}{command}"
+            yield (f"{cls.PREFIX}{command}", action, help_text)
+
+    async def discover(self) -> Hits:
+        """Handle a request to discover commands.
+
+        Yields:
+            Command discovery hits for the command palette.
+        """
+
+        # Nothing in here makes sense if the user isn't current on a
+        # Mandelbrot set.
+        if not isinstance(self.focused, Mandelbrot):
+            return
+
+        # Spin out some commands for setting the colours.
+        for command, source, help_text in self._colour_commands():
+            yield DiscoveryHit(
+                command,
+                partial(self.focused.set_colour_source, source),
+                command,
+                help_text,
+            )
+
+        # Spin out the action commands.
+        for command, action, help_text in self._action_commands():
+            yield DiscoveryHit(
+                command,
+                partial(self.focused.run_action, action),
+                command,
+                help_text,
+            )
+
+    async def search(self, query: str) -> Hits:
+        """Handle a request to search for system commands that match the query.
+
+        Args:
+            user_input: The user input to be matched.
+
+        Yields:
+            Command hits for use in the command palette.
+        """
+
+        # Nothing in here makes sense if the user isn't current on a
+        # Mandelbrot set.
+        if not isinstance(self.focused, Mandelbrot):
+            return
+
+        # Get a fuzzy matcher for looking for hits.
+        matcher = self.matcher(query)
+
+        # Spin out some commands for setting the colours.
+        for command, source, help_text in self._colour_commands():
+            match = matcher.match(command)
+            if match:
+                yield Hit(
+                    match,
+                    matcher.highlight(command),
+                    partial(self.focused.set_colour_source, source),
+                    help=help_text,
+                )
+
+        # Spin out the action commands.
+        for command, action, help_text in self._action_commands():
             match = matcher.match(command)
             if match:
                 yield Hit(