command_watcher 0.5.0__tar.gz → 0.7.0__tar.gz

command_watcher-0.7.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: command_watcher
+Version: 0.7.0
+Summary: Module to watch the execution of shell scripts. Both streams (`stdout` and `stderr`) are captured.
+Author: Josef Friedrich
+Author-email: Josef Friedrich <josef@friedrich.rocks>
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pretiac>=0.6.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: termcolor>=3.3.0
+Requires-Dist: types-pyyaml>=6.0.12.20250915
+Requires-Dist: types-requests>=2.32.4.20260107
+Requires-Dist: types-termcolor>=1.1.6.2
+Requires-Python: >=3.12, <4
+Project-URL: Repository, https://github.com/Josef-Friedrich/command-watcher
+Description-Content-Type: text/x-rst
+
+.. image:: http://img.shields.io/pypi/v/command-watcher.svg
+    :target: https://pypi.org/project/command-watcher
+    :alt: This package on the Python Package Index
+
+.. image:: https://github.com/Josef-Friedrich/command-watcher/actions/workflows/tests.yml/badge.svg
+    :target: https://github.com/Josef-Friedrich/command-watcher/actions/workflows/tests.yml
+    :alt: Tests
+
+command_watcher
+===============
+
+Module to watch the execution of shell scripts. Both streams (`stdout`
+and `stderr`) are captured.
+
+The watcher's loggers print each message once and do not propagate it to
+Python's root logger. Command output is also stored on the command executor
+and, unless ``log=False`` is passed to ``watch.run()``, on the watcher.
+
+.. code:: python
+
+    watch = Watch()
+    watch.log.critical('msg')
+    watch.log.error('msg')
+    watch.log.warning('msg')
+    watch.log.info('msg')
+    watch.log.debug('msg')
+    watch.run(['rsync', '-av', '/home', '/backup'])
+
+.. code-block:: python
+
+    #! /opt/venvs/command_watcher/bin/python
+
+    from command_watcher import Watch
+    watch = Watch(
+        config_file='/etc/command-watcher.yml',
+        service_name='texlive_update'
+    )
+
+    tlmgr = '/usr/local/texlive/bin/x86_64-linux/tlmgr'
+
+    watch.run(f'{tlmgr} update --self')
+    watch.run(f'{tlmgr} update --all')
+    installed_packages = watch.run(
+        f'{tlmgr} info --only-installed', log=False
+    )
+    all_packages = watch.run(f'{tlmgr} info', log=False)
+
+    watch.final_report(
+        status=0,
+        performance_data={
+            'installed_packages': installed_packages.line_count_stdout,
+            'all_packages': all_packages.line_count_stdout,
+        },
+    )
+
+.. code-block:: yaml
+
+        ---
+        email:
+            from_addr: logs@example.com
+            to_addr: logs@example.com
+            to_addr_critical: critical@example.com
+            smtp_login: mailer@mail.example.com
+            smtp_password: abcd
+            smtp_server: mail.example.com:587
+
+        icinga:
+            api_endpoint_host: localhost
+            api_endpoint_port: 5665
+            client_private_key: /etc/pretiac/api-client.key.pem
+            client_certificate: /etc/pretiac/api-client.cert.pem
+            ca_certificate: /etc/pretiac/ca.crt
+            new_host_defaults:
+                templates: [passive-host]
+            new_service_defaults:
+                templates: [passive-service]
+                attrs:
+                check_interval: monthly
+
+        beep:
+            activated: true

command_watcher-0.7.0/README.rst

@@ -0,0 +1,81 @@
+.. image:: http://img.shields.io/pypi/v/command-watcher.svg
+    :target: https://pypi.org/project/command-watcher
+    :alt: This package on the Python Package Index
+
+.. image:: https://github.com/Josef-Friedrich/command-watcher/actions/workflows/tests.yml/badge.svg
+    :target: https://github.com/Josef-Friedrich/command-watcher/actions/workflows/tests.yml
+    :alt: Tests
+
+command_watcher
+===============
+
+Module to watch the execution of shell scripts. Both streams (`stdout`
+and `stderr`) are captured.
+
+The watcher's loggers print each message once and do not propagate it to
+Python's root logger. Command output is also stored on the command executor
+and, unless ``log=False`` is passed to ``watch.run()``, on the watcher.
+
+.. code:: python
+
+    watch = Watch()
+    watch.log.critical('msg')
+    watch.log.error('msg')
+    watch.log.warning('msg')
+    watch.log.info('msg')
+    watch.log.debug('msg')
+    watch.run(['rsync', '-av', '/home', '/backup'])
+
+.. code-block:: python
+
+    #! /opt/venvs/command_watcher/bin/python
+
+    from command_watcher import Watch
+    watch = Watch(
+        config_file='/etc/command-watcher.yml',
+        service_name='texlive_update'
+    )
+
+    tlmgr = '/usr/local/texlive/bin/x86_64-linux/tlmgr'
+
+    watch.run(f'{tlmgr} update --self')
+    watch.run(f'{tlmgr} update --all')
+    installed_packages = watch.run(
+        f'{tlmgr} info --only-installed', log=False
+    )
+    all_packages = watch.run(f'{tlmgr} info', log=False)
+
+    watch.final_report(
+        status=0,
+        performance_data={
+            'installed_packages': installed_packages.line_count_stdout,
+            'all_packages': all_packages.line_count_stdout,
+        },
+    )
+
+.. code-block:: yaml
+
+        ---
+        email:
+            from_addr: logs@example.com
+            to_addr: logs@example.com
+            to_addr_critical: critical@example.com
+            smtp_login: mailer@mail.example.com
+            smtp_password: abcd
+            smtp_server: mail.example.com:587
+
+        icinga:
+            api_endpoint_host: localhost
+            api_endpoint_port: 5665
+            client_private_key: /etc/pretiac/api-client.key.pem
+            client_certificate: /etc/pretiac/api-client.cert.pem
+            ca_certificate: /etc/pretiac/ca.crt
+            new_host_defaults:
+                templates: [passive-host]
+            new_service_defaults:
+                templates: [passive-service]
+                attrs:
+                check_interval: monthly
+
+        beep:
+            activated: true

command_watcher-0.7.0/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "command_watcher"
+version = "0.7.0"
+description = "Module to watch the execution of shell scripts. Both streams (`stdout` and `stderr`) are captured."
+requires-python = ">=3.12,<4"
+readme = "README.rst"
+license = "MIT"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "pretiac>=0.6.0",
+    "pydantic>=2.12.5",
+    "pyyaml>=6.0.3",
+    "termcolor>=3.3.0",
+    "types-pyyaml>=6.0.12.20250915",
+    "types-requests>=2.32.4.20260107",
+    "types-termcolor>=1.1.6.2",
+]
+
+[[project.authors]]
+name = "Josef Friedrich"
+email = "josef@friedrich.rocks"
+
+[project.urls]
+Repository = "https://github.com/Josef-Friedrich/command-watcher"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.0",
+    "pytest>=9.0.2",
+    "stdout-stderr-capturing>=0.2.1",
+]
+
+[tool.uv.sources.pretiac]
+git = "https://github.com/Josef-Friedrich/PREtty-Typed-Icinga2-Api-Client_py.git"
+
+[tool.pytest.ini_options]
+verbosity_assertions = 2
+truncation_limit_lines = 999999
+truncation_limit_chars = 999999
+
+[build-system]
+requires = ["uv_build>=0.13.7,<0.14.0"]
+build-backend = "uv_build"

command_watcher-0.7.0/pyproject.toml.orig

@@ -0,0 +1,50 @@
+[project]
+name = "command_watcher"
+version = "0.7.0"
+description = "Module to watch the execution of shell scripts. Both streams (`stdout` and `stderr`) are captured."
+authors = [{ name = "Josef Friedrich", email = "josef@friedrich.rocks" }]
+requires-python = ">=3.12,<4"
+readme = "README.rst"
+license = "MIT"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "pretiac>=0.6.0",
+    "pydantic>=2.12.5",
+    "pyyaml>=6.0.3",
+    "termcolor>=3.3.0",
+    "types-pyyaml>=6.0.12.20250915",
+    "types-requests>=2.32.4.20260107",
+    "types-termcolor>=1.1.6.2",
+]
+
+[project.urls]
+Repository = "https://github.com/Josef-Friedrich/command-watcher"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.0",
+    "pytest>=9.0.2",
+    "stdout-stderr-capturing>=0.2.1",
+]
+
+[tool.uv]
+
+[tool.uv.sources]
+pretiac = { git = "https://github.com/Josef-Friedrich/PREtty-Typed-Icinga2-Api-Client_py.git" }
+
+[build-system]
+requires = ["uv_build>=0.13.7,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+verbosity_assertions = 2
+truncation_limit_lines = 999999
+truncation_limit_chars = 999999