logrunner 0.0.4__tar.gz

logrunner-0.0.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2026] [Chris 'KageKirin' Helmich]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

logrunner-0.0.4/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: logrunner
+Version: 0.0.4
+Summary: logrunner.run([cmd]) wraps subprocess.run([cmd]) to allow continuous output as well as capture of stdout
+Author-email: kagekirin <kagekirin@gmail.com>
+Maintainer-email: kagekirin <kagekirin@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/KageKirin/py-logrunner
+Project-URL: Documentation, https://github.com/KageKirin/py-logrunner
+Project-URL: Repository, https://github.com/KageKirin/py-logrunner.git
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# Logrunner
+
+`logrunner.run([cmd])` wraps `subprocess.run([cmd])` to allow continuous output as well as capture of stdout and stderr.
+
+This function is intended for usage in CI and other process monitoring applications where
+the process outputs need to be written for real-time error tracking
+and captured for post-processing text analysis.
+
+## ⚡ Usage
+
+```python
+import logrunner
+
+(ret, out, err) = logrunner.run(["echo", "hello"])
+# returns (0, "hello", "")
+
+(ret, out, err) = logrunner.run(["ls", "/nonexistentpath"])
+# return (1, "", "No such file or directory")
+```
+
+## 🔧 Building
+
+```shell
+uv build
+```
+
+## 🤝 Collaborate with My Project
+
+Please refer to the [collaboration guidelines](./COLLABORATION.md) for details.

logrunner-0.0.4/README.md

@@ -0,0 +1,29 @@
+# Logrunner
+
+`logrunner.run([cmd])` wraps `subprocess.run([cmd])` to allow continuous output as well as capture of stdout and stderr.
+
+This function is intended for usage in CI and other process monitoring applications where
+the process outputs need to be written for real-time error tracking
+and captured for post-processing text analysis.
+
+## ⚡ Usage
+
+```python
+import logrunner
+
+(ret, out, err) = logrunner.run(["echo", "hello"])
+# returns (0, "hello", "")
+
+(ret, out, err) = logrunner.run(["ls", "/nonexistentpath"])
+# return (1, "", "No such file or directory")
+```
+
+## 🔧 Building
+
+```shell
+uv build
+```
+
+## 🤝 Collaborate with My Project
+
+Please refer to the [collaboration guidelines](./COLLABORATION.md) for details.

logrunner-0.0.4/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["wheel", "setuptools",  "attrs>=17.1", "versioningit"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "logrunner"
+dynamic = ["version"]
+description = "logrunner.run([cmd]) wraps subprocess.run([cmd]) to allow continuous output as well as capture of stdout"
+readme = "README.md"
+requires-python = ">= 3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+
+authors = [
+  {name = "kagekirin", email = "kagekirin@gmail.com"},
+]
+maintainers = [
+  {name = "kagekirin", email = "kagekirin@gmail.com"},
+]
+
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Libraries",
+]
+
+
+
+[project.urls]
+Homepage = "https://github.com/KageKirin/py-logrunner"
+Documentation = "https://github.com/KageKirin/py-logrunner"
+Repository = "https://github.com/KageKirin/py-logrunner.git"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=9.0",
+  "ruff",
+]
+
+[tool.pytest]
+minversion = "9.0"
+addopts = ["-ra", "-q"]
+pythonpath = ["src"]
+testpaths = [
+  "tests",
+]
+
+
+[tool.setuptools.packages.find]
+where = ["src/"]
+include = ["logrunner"]
+
+[tool.versioningit.next-version]
+method = "smallest"
+
+[tool.versioningit.format]
+distance = "{next_version}.dev{distance}+{vcs}{rev}"
+dirty = "{base_version}+d{build_date:%Y%m%d}"
+distance-dirty = "{next_version}.dev{distance}+{vcs}{rev}.d{build_date:%Y%m%d}"

logrunner-0.0.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

logrunner-0.0.4/src/logrunner/__init__.py

@@ -0,0 +1,90 @@
+## logrunner
+
+# namespace: logrunner
+
+import io
+import sys
+import selectors
+import subprocess
+
+
+def run(
+    args,
+    *,
+    stdin=None,
+    cwd=None,
+    check=False,
+    encoding=None,
+    errors=None,
+    text=None,
+    env=None,
+    **other_popen_kwargs,
+):
+
+    stdoutbuf = io.StringIO()
+    stderrbuf = io.StringIO()
+
+    kwargs = {
+        "stdout": subprocess.PIPE,
+        "stderr": subprocess.PIPE,  # STDOUT to pipe STDERR into STDOUT for simultaneous capture
+        "bufsize": 1,  # bufsize = 1 means output is line buffered
+        "universal_newlines": True,  # required for line buffering
+        ## forwarding the remaining params
+        "stdin": stdin,
+        "cwd": cwd,
+        # timeout=timeout,
+        "errors": errors,
+        "text": text,
+        "env": env,
+        **other_popen_kwargs,
+    }
+
+    # Start subprocess
+    process = subprocess.Popen(args, **kwargs)
+
+    # Callback function for process STDOUT
+    def handle_stdout(stream, mask):
+        # NOTE: Because the process' output is line buffered, there's only ever one line to read when this function is called
+        line = stream.readline()
+        stdoutbuf.write(line)
+        sys.stdout.write(line)
+
+    # Callback function for process STDERR
+    def handle_stderr(stream, mask):
+        # NOTE: Because the process' output is line buffered, there's only ever one line to read when this function is called
+        line = stream.readline()
+        stderrbuf.write(line)
+        sys.stderr.write(line)
+
+    # Register callback for an "available for read" event from subprocess' stdout stream
+    selector = selectors.DefaultSelector()
+    selector.register(process.stdout, selectors.EVENT_READ, handle_stdout)
+    selector.register(process.stderr, selectors.EVENT_READ, handle_stderr)
+
+    # Loop until subprocess is terminated
+    while process.poll() is None:
+        # Wait for events and handle them with their registered callbacks
+        events = selector.select()
+        for key, mask in events:
+            callback = key.data
+            callback(key.fileobj, mask)
+
+    # Get process return code
+    returncode = process.wait()
+    selector.close()
+
+    # Store buffered output
+    stdoutput = stdoutbuf.getvalue()
+    stdoutbuf.close()
+    stderrput = stderrbuf.getvalue()
+    stderrbuf.close()
+
+    if check and returncode != 0:
+        raise subprocess.CalledProcessError(
+            returncode=returncode,
+            cmd=" ".join(args),
+            output=stdoutput,
+            stderr=stderrput,
+        )
+
+    return (returncode, stdoutput, stderrput)

logrunner-0.0.4/src/logrunner.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: logrunner
+Version: 0.0.4
+Summary: logrunner.run([cmd]) wraps subprocess.run([cmd]) to allow continuous output as well as capture of stdout
+Author-email: kagekirin <kagekirin@gmail.com>
+Maintainer-email: kagekirin <kagekirin@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/KageKirin/py-logrunner
+Project-URL: Documentation, https://github.com/KageKirin/py-logrunner
+Project-URL: Repository, https://github.com/KageKirin/py-logrunner.git
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# Logrunner
+
+`logrunner.run([cmd])` wraps `subprocess.run([cmd])` to allow continuous output as well as capture of stdout and stderr.
+
+This function is intended for usage in CI and other process monitoring applications where
+the process outputs need to be written for real-time error tracking
+and captured for post-processing text analysis.
+
+## ⚡ Usage
+
+```python
+import logrunner
+
+(ret, out, err) = logrunner.run(["echo", "hello"])
+# returns (0, "hello", "")
+
+(ret, out, err) = logrunner.run(["ls", "/nonexistentpath"])
+# return (1, "", "No such file or directory")
+```
+
+## 🔧 Building
+
+```shell
+uv build
+```
+
+## 🤝 Collaborate with My Project
+
+Please refer to the [collaboration guidelines](./COLLABORATION.md) for details.

logrunner-0.0.4/src/logrunner.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/logrunner/__init__.py
+src/logrunner.egg-info/PKG-INFO
+src/logrunner.egg-info/SOURCES.txt
+src/logrunner.egg-info/dependency_links.txt
+src/logrunner.egg-info/requires.txt
+src/logrunner.egg-info/top_level.txt
+tests/test_logrunner.py

logrunner-0.0.4/src/logrunner.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

logrunner-0.0.4/src/logrunner.egg-info/requires.txt

@@ -0,0 +1,4 @@
+
+[dev]
+pytest>=9.0
+ruff

logrunner-0.0.4/src/logrunner.egg-info/top_level.txt

@@ -0,0 +1 @@
+logrunner

logrunner-0.0.4/tests/test_logrunner.py

@@ -0,0 +1,17 @@
+import logrunner
+import pytest
+
+def test():
+    (ret, out, err) = logrunner.run(["echo", "hello"])
+    assert ret == 0
+    assert out.strip() == "hello"
+    assert err == ""
+
+def test_error():
+    (ret, out, err) = logrunner.run(["ls", "/nonexistentpath"])
+    assert ret != 0
+    assert out == ""
+    assert "No such file or directory" in err
+
+if __name__ == "__main__":
+    pytest.main()