py-wait-until 0.0.1__tar.gz

py_wait_until-0.0.1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,34 @@
+<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/pyproject.toml

@@ -0,0 +1,121 @@
+# yaml-language-server: $schema=https://json.schemastore.org/pyproject.json
+
+[build-system]
+requires = ["uv_build>=0.8.2,<1.0"]
+build-backend = "uv_build"
+
+[project]
+name = "py-wait-until"
+version = "0.0.1"
+description = "Print a loading spinner while another process is running."
+authors = [{name = "billwallis"}]
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = []
+
+[project.scripts]
+py-wait-until = "py_wait_until.main:main"
+
+[dependency-groups]
+dev = [
+    "coverage-badge>=1.1.2",
+    "poethepoet>=0.37.0",
+    "pre-commit>=4.3.0",
+]
+test = [
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+]
+
+
+[tool.uv]
+required-version = ">=0.8,<1.0"
+default-groups = "all"
+
+
+[tool.poe]
+verbosity = -1
+
+[tool.poe.tasks]
+install.shell = """
+    uv sync --refresh
+    pre-commit install --install-hooks
+"""
+update.shell = """
+    uv sync --refresh --upgrade
+    pre-commit autoupdate
+    pre-commit install --install-hooks
+"""
+test = "uv run pytest -vvv"
+
+[tool.poe.tasks.lint]
+control.expr = "sys.platform"
+
+[[tool.poe.tasks.lint.switch]]
+case = "win32"
+shell = """
+    echo '=== pre-commit checks ==='
+    SKIP=identity pre-commit run --all-files --hook-stage pre-commit
+    echo '=== pre-push checks ==='
+    pre-commit run --all-files --hook-stage pre-push
+"""
+
+[[tool.poe.tasks.lint.switch]]
+shell = """
+    echo '\\033[0;34mpre-commit checks\\033[0m'
+    SKIP=identity pre-commit run --all-files --hook-stage pre-commit
+    echo '\\033[0;34mpre-push checks\\033[0m'
+    pre-commit run --all-files --hook-stage pre-push
+"""
+
+
+[tool.pytest.ini_options]
+addopts = "--cov=src --cov-fail-under=80"
+testpaths = ["tests"]
+
+
+[tool.ruff]
+line-length = 80
+indent-width = 4
+target-version = "py313"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint]
+select = [
+    "ANN",   # flake8-annotations
+    "B",     # flake8-bugbear
+    "E",     # pycodestyle-error
+    "F",     # Pyflakes
+    "FURB",  # refurb
+    "I",     # isort
+    "N",     # pep8-naming
+    "PL",    # Pylint
+    "PERF",  # Perflint
+    "RUF",   # Ruff-specific
+    "S",     # flake8-bandit
+    "UP",    # pyupgrade
+    "W",     # pycodestyle-warning
+]
+ignore = [
+    "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed
+    "E501",    # Line too long
+]
+fixable = ["ALL"]
+unfixable = []
+# Allow unused variables when underscore-prefixed
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+# https://github.com/astral-sh/ruff/issues/4368
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/**/*.py" = [
+    "ANN001",   # Missing type annotation for function argument
+    "ANN201",   # Missing return type annotation for public function
+    "S101",     # Use of `assert` detected
+    "PLR2004",  # Magic value used in comparison
+    "PLR0913",  # Too many arguments in function definition
+]

py_wait_until-0.0.1/src/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