py-wait-until 0.0.1__tar.gz → 0.0.3__tar.gz

py_wait_until-0.0.1/README.md → py_wait_until-0.0.3/PKG-INFO

@@ -1,3 +1,11 @@
+Metadata-Version: 2.3
+Name: py-wait-until
+Version: 0.0.3
+Summary: Print a loading spinner while another command is running.
+Author: billwallis
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
 <span align="center">
 
 [![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/)
@@ -15,16 +23,37 @@
 
 # Wait Until
 
-Print a loading spinner while another process is running.
+Print a loading spinner while another command is running.
 
 ## Usage
 
-Simply prepend `py-wait-until` to any command:
+`py-wait-until` is a CLI tool which runs a command and displays a loading spinner while the command is executing.
+
+The easiest way to use `py-wait-until` is via [`uvx`](https://docs.astral.sh/uv/guides/tools/), for example:
 
 ```shell
+uvx py-wait-until python -c "import time; time.sleep(2)"
+```
+
+Alternatively, install from PyPI and run without `uvx`:
+
+```shell
+pip install py-wait-until
 py-wait-until python -c "import time; time.sleep(2)"
 ```
 
+The return code of the original command is preserved. Specifying no command will exit with code 1 and show the help message.
+
+### Custom loading message
+
+You can specify a custom loading message using the `--message` (or `-m`) option:
+
+```shell
+uvx py-wait-until --message "Processing..." python -c "import time; time.sleep(2)"
+```
+
+This option _must_ be specified before the command to run
+
 ## Contributing
 
 Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and then install the dependencies:

py_wait_until-0.0.1/PKG-INFO → py_wait_until-0.0.3/README.md

@@ -1,11 +1,3 @@
-Metadata-Version: 2.3
-Name: py-wait-until
-Version: 0.0.1
-Summary: Print a loading spinner while another process is running.
-Author: billwallis
-Requires-Python: >=3.13
-Description-Content-Type: text/markdown
-
 <span align="center">
 
 [![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/)
@@ -23,16 +15,37 @@ Description-Content-Type: text/markdown
 
 # Wait Until
 
-Print a loading spinner while another process is running.
+Print a loading spinner while another command is running.
 
 ## Usage
 
-Simply prepend `py-wait-until` to any command:
+`py-wait-until` is a CLI tool which runs a command and displays a loading spinner while the command is executing.
+
+The easiest way to use `py-wait-until` is via [`uvx`](https://docs.astral.sh/uv/guides/tools/), for example:
 
 ```shell
+uvx py-wait-until python -c "import time; time.sleep(2)"
+```
+
+Alternatively, install from PyPI and run without `uvx`:
+
+```shell
+pip install py-wait-until
 py-wait-until python -c "import time; time.sleep(2)"
 ```
 
+The return code of the original command is preserved. Specifying no command will exit with code 1 and show the help message.
+
+### Custom loading message
+
+You can specify a custom loading message using the `--message` (or `-m`) option:
+
+```shell
+uvx py-wait-until --message "Processing..." python -c "import time; time.sleep(2)"
+```
+
+This option _must_ be specified before the command to run
+
 ## Contributing
 
 Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and then install the dependencies:

{py_wait_until-0.0.1 → py_wait_until-0.0.3}/pyproject.toml

@@ -6,8 +6,8 @@ build-backend = "uv_build"
 
 [project]
 name = "py-wait-until"
-version = "0.0.1"
-description = "Print a loading spinner while another process is running."
+version = "0.0.3"
+description = "Print a loading spinner while another command is running."
 authors = [{name = "billwallis"}]
 readme = "README.md"
 requires-python = ">=3.13"

{py_wait_until-0.0.1 → py_wait_until-0.0.3}/src/py_wait_until/main.py

@@ -32,7 +32,7 @@ def _spinner() -> Generator[str]:
         yield chars[index % len(chars)]
 
 
-def _wait_for_process(cmd: list[str]) -> int:
+def _wait_for_process(cmd: list[str], message: str) -> int:
     """
     Execute a command and display a waiting message until it completes.
     """
@@ -53,7 +53,7 @@ def _wait_for_process(cmd: list[str]) -> int:
         if is_tty:
             _write_line(
                 sys.stdout,
-                f"\rWaiting for process to finish... {next(spin)}",
+                f"\r{message} {next(spin)}",
             )
         time.sleep(WAIT_DURATION_SECONDS)
 
@@ -72,16 +72,24 @@ def _wait_for_process(cmd: list[str]) -> int:
 
 def main(argv: Sequence[str] | None = None) -> int:
     """
-    Wait until a command completes.
+    Print a loading spinner while another process is running.
     """
 
     parser = argparse.ArgumentParser(
-        description="Wait until a command completes.",
+        description="Print a loading spinner while another command is running.",
     )
     parser.add_argument(
         "command",
         nargs=argparse.REMAINDER,
-        help="Command and arguments to execute",
+        help="Command(s) to execute",
+    )
+    parser.add_argument(
+        "-m",
+        "--message",
+        type=str,
+        required=False,
+        default="Waiting for process to finish...",
+        help="Message to display while waiting",
     )
 
     args = parser.parse_args(argv)
@@ -89,7 +97,10 @@ def main(argv: Sequence[str] | None = None) -> int:
         parser.print_help()
         return 1
 
-    return _wait_for_process(args.command)
+    return _wait_for_process(
+        cmd=args.command,
+        message=args.message,
+    )
 
 
 if __name__ == "__main__":