py-wait-until 0.0.1__py3-none-any.whl

py_wait_until/main.py

@@ -0,0 +1,96 @@
+import argparse
+import subprocess
+import sys
+import time
+from collections.abc import Generator, Sequence
+from typing import TextIO
+
+WAIT_DURATION_SECONDS = 0.1
+ANSI_CLEAR_LINE = "\033[2K"
+ANSI_HIDE_CURSOR = "\033[?25l"
+ANSI_SHOW_CURSOR = "\033[?25h"
+
+
+def _write_line(stream: TextIO, message: str) -> None:
+    """
+    Write and flush a line to the given stream.
+    """
+
+    stream.write(message)
+    stream.flush()
+
+
+def _spinner() -> Generator[str]:
+    """
+    Return an infinite generator that yields spinner characters.
+    """
+
+    chars = ["|", "/", "-", "\\"]
+    index = -1
+    while True:
+        index += 1
+        yield chars[index % len(chars)]
+
+
+def _wait_for_process(cmd: list[str]) -> int:
+    """
+    Execute a command and display a waiting message until it completes.
+    """
+
+    # Only show spinner if stdout is a TTY (interactive terminal)
+    if is_tty := sys.stdout.isatty():
+        _write_line(sys.stdout, ANSI_HIDE_CURSOR)
+
+    process = subprocess.Popen(  # noqa: S603
+        cmd,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True,
+    )
+
+    spin = _spinner()
+    while process.poll() is None:
+        if is_tty:
+            _write_line(
+                sys.stdout,
+                f"\rWaiting for process to finish... {next(spin)}",
+            )
+        time.sleep(WAIT_DURATION_SECONDS)
+
+    if is_tty:
+        _write_line(sys.stdout, f"\r{ANSI_CLEAR_LINE}")
+        _write_line(sys.stdout, ANSI_SHOW_CURSOR)
+
+    stdout, stderr = process.communicate()
+    if stdout:
+        _write_line(sys.stdout, stdout)
+    if stderr:
+        _write_line(sys.stderr, stderr)
+
+    return process.returncode
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    """
+    Wait until a command completes.
+    """
+
+    parser = argparse.ArgumentParser(
+        description="Wait until a command completes.",
+    )
+    parser.add_argument(
+        "command",
+        nargs=argparse.REMAINDER,
+        help="Command and arguments to execute",
+    )
+
+    args = parser.parse_args(argv)
+    if not args.command:
+        parser.print_help()
+        return 1
+
+    return _wait_for_process(args.command)
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())  # pragma: no cover

py_wait_until-0.0.1.dist-info/METADATA

@@ -0,0 +1,42 @@
+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/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![tests](https://github.com/billwallis/py-wait-until/actions/workflows/tests.yaml/badge.svg)](https://github.com/billwallis/py-wait-until/actions/workflows/tests.yaml)
+[![coverage](https://raw.githubusercontent.com/billwallis/py-wait-until/refs/heads/main/coverage.svg)](https://github.com/dbrgn/coverage-badge)
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/billwallis/py-wait-until/main.svg)](https://results.pre-commit.ci/latest/github/billwallis/py-wait-until/main)
+[![GitHub last commit](https://img.shields.io/github/last-commit/billwallis/py-wait-until)](https://shields.io/badges/git-hub-last-commit)
+
+</span>
+
+---
+
+# Wait Until
+
+Print a loading spinner while another process is running.
+
+## Usage
+
+Simply prepend `py-wait-until` to any command:
+
+```shell
+py-wait-until python -c "import time; time.sleep(2)"
+```
+
+## Contributing
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and then install the dependencies:
+
+```bash
+uvx --from poethepoet poe install
+```

py_wait_until-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+py_wait_until/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_wait_until/main.py,sha256=eansiUoTZOUImJHIlfai7xW3PrsTrmJIm3iGt8TkOlM,2226
+py_wait_until-0.0.1.dist-info/WHEEL,sha256=YUH1mBqsx8Dh2cQG2rlcuRYUhJddG9iClegy4IgnHik,79
+py_wait_until-0.0.1.dist-info/entry_points.txt,sha256=ekKOf3eXkTa9pFubMq_7hXO3ct2xKP5eyzaGt2Vc7cs,59
+py_wait_until-0.0.1.dist-info/METADATA,sha256=ae37rwzjsbQye8ad9KGdHb6ToPxQGY15UxPiOFT7l_E,1652
+py_wait_until-0.0.1.dist-info/RECORD,,

py_wait_until-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.11
+Root-Is-Purelib: true
+Tag: py3-none-any

py_wait_until-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+py-wait-until = py_wait_until.main:main
+