watch-diff 0.7.0__tar.gz

watch_diff-0.7.0/.github/workflows/build.yml

@@ -0,0 +1,17 @@
+name: Build
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run tests
+        run: python -m unittest -v

watch_diff-0.7.0/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+watch_diff.egg-info/

watch_diff-0.7.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2019 Francis Bergin
+
+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.

watch_diff-0.7.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: watch-diff
+Version: 0.7.0
+Summary: Watch command output and get notified on changes
+Author-email: Francis Bergin <me@francisbergin.ca>
+Maintainer-email: Francis Bergin <me@francisbergin.ca>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# watch-diff
+
+[![PyPI](https://img.shields.io/pypi/v/watch-diff.svg)](https://pypi.org/project/watch-diff)
+
+## setup
+
+```shell
+pip install watch-diff
+```
+
+## usage
+
+```console
+$ watch-diff --help
+usage: watch-diff [-h] [-v | -d] [-i SECONDS] [-r RECIPIENT] command
+
+Watch command output and get notified on changes
+
+positional arguments:
+  command               the command to watch
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -i SECONDS, --interval SECONDS
+                        number of seconds between executions
+  -r RECIPIENT, --recipient RECIPIENT
+                        send email to recipient
+
+logging level:
+  -v, --verbose         enable verbose output
+  -d, --debug           show debugging statements
+```
+
+## credentials
+
+```shell
+export SMTP_HOST=qwer.ty
+export SMTP_PORT=1234
+export SMTP_USER=qwer@qwer.ty
+read -s -p "SMTP_PASS: " SMTP_PASS
+export SMTP_PASS
+```
+
+## development
+
+```shell
+# setup
+python3 -m venv venv && . venv/bin/activate
+
+# editable install
+pip install -e .[dev]
+
+# running tests
+python -m unittest -v
+```

watch_diff-0.7.0/README.md

@@ -0,0 +1,55 @@
+# watch-diff
+
+[![PyPI](https://img.shields.io/pypi/v/watch-diff.svg)](https://pypi.org/project/watch-diff)
+
+## setup
+
+```shell
+pip install watch-diff
+```
+
+## usage
+
+```console
+$ watch-diff --help
+usage: watch-diff [-h] [-v | -d] [-i SECONDS] [-r RECIPIENT] command
+
+Watch command output and get notified on changes
+
+positional arguments:
+  command               the command to watch
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -i SECONDS, --interval SECONDS
+                        number of seconds between executions
+  -r RECIPIENT, --recipient RECIPIENT
+                        send email to recipient
+
+logging level:
+  -v, --verbose         enable verbose output
+  -d, --debug           show debugging statements
+```
+
+## credentials
+
+```shell
+export SMTP_HOST=qwer.ty
+export SMTP_PORT=1234
+export SMTP_USER=qwer@qwer.ty
+read -s -p "SMTP_PASS: " SMTP_PASS
+export SMTP_PASS
+```
+
+## development
+
+```shell
+# setup
+python3 -m venv venv && . venv/bin/activate
+
+# editable install
+pip install -e .[dev]
+
+# running tests
+python -m unittest -v
+```

watch_diff-0.7.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "watch-diff"
+version = "0.7.0"
+description = "Watch command output and get notified on changes"
+readme = "README.md"
+authors = [
+    {name = "Francis Bergin", email = "me@francisbergin.ca"},
+]
+maintainers = [
+    {name = "Francis Bergin", email = "me@francisbergin.ca"},
+]
+license = "MIT"
+requires-python = ">=3.10"
+dependencies = []
+
+[project.scripts]
+watch-diff = "watch_diff.__main__:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

watch_diff-0.7.0/tests/test_watch_diff.py

@@ -0,0 +1,40 @@
+"""
+"""
+
+import os
+import unittest
+
+import watch_diff
+
+
+smtp_host = os.environ.get('SMTP_HOST')
+smtp_port = os.environ.get('SMTP_PORT')
+smtp_user = os.environ.get('SMTP_USER')
+smtp_pass = os.environ.get('SMTP_PASS')
+
+
+class TestWatchDiff(unittest.TestCase):
+
+    def test_api_available(self):
+        self.assertTrue(watch_diff.Command)
+        self.assertTrue(watch_diff.Diff)
+        self.assertTrue(watch_diff.Email)
+        self.assertTrue(watch_diff.DefaultFormatter)
+        self.assertTrue(watch_diff.ConsoleFormatter)
+        self.assertTrue(watch_diff.HTMLFormatter)
+        self.assertTrue(watch_diff.OutputFormatting)
+
+    def test_command(self):
+        c = watch_diff.Command('date')
+        self.assertFalse(c)
+        d = c.run()
+        self.assertTrue(c)
+        self.assertTrue(d)
+
+    @unittest.skipIf(not smtp_host, 'SMTP_HOST is not available')
+    @unittest.skipIf(not smtp_port, 'SMTP_PORT is not available')
+    @unittest.skipIf(not smtp_user, 'SMTP_USER is not available')
+    @unittest.skipIf(not smtp_pass, 'SMTP_PASS is not available')
+    def test_email(self):
+        e = watch_diff.Email(smtp_host, smtp_port, smtp_user, smtp_pass, 'watch-diff-tests', smtp_user)
+        e.send_email('watch diff tests', 'text', 'html')

watch_diff-0.7.0/uv.lock

@@ -0,0 +1,8 @@
+version = 1
+revision = 3
+requires-python = ">=3.10"
+
+[[package]]
+name = "watch-diff"
+version = "0.7.0"
+source = { editable = "." }

watch_diff-0.7.0/watch_diff/__init__.py

@@ -0,0 +1,10 @@
+"""
+"""
+
+__version__ = '0.6.0'
+
+
+from .command import Command
+from .diff import Diff
+from .email import Email
+from .format import DefaultFormatter, ConsoleFormatter, HTMLFormatter, OutputFormatting

watch_diff-0.7.0/watch_diff/__main__.py

@@ -0,0 +1,83 @@
+"""
+"""
+
+import argparse
+import datetime
+import getpass
+import logging
+import os
+import time
+
+from email.utils import make_msgid
+
+from . import command
+from . import email
+
+
+logger = logging.getLogger(__name__)
+
+parser = argparse.ArgumentParser(description='Watch command output and get notified on changes')
+logging_group = parser.add_argument_group('logging level').add_mutually_exclusive_group()
+logging_group.add_argument('-v', '--verbose', action='store_const',
+                           const=logging.INFO, default=logging.CRITICAL,
+                           dest='loglevel', help='enable verbose output')
+logging_group.add_argument('-d', '--debug', action='store_const',
+                           const=logging.DEBUG, dest='loglevel',
+                           help='show debugging statements')
+parser.add_argument('-i', '--interval', type=int, default=5, metavar='SECONDS', help='number of seconds between executions')
+parser.add_argument('-r', '--recipient', help='send email to recipient')
+parser.add_argument('command', help='the command to watch')
+
+
+def _main():
+    args = parser.parse_args()
+    logging.basicConfig(level=args.loglevel)
+    e = None
+
+    if args.recipient:
+        smtp_host = os.environ.get('SMTP_HOST') or input('SMTP_HOST: ')
+        smtp_port = os.environ.get('SMTP_PORT') or input('SMTP_PORT: ')
+        smtp_user = os.environ.get('SMTP_USER') or input('SMTP_USER: ')
+        smtp_pass = os.environ.get('SMTP_PASS') or getpass.getpass('SMTP_PASS: ')
+        e = email.Email(smtp_host, smtp_port, smtp_user, smtp_pass, 'watch-diff', args.recipient)
+
+    first_run = True
+    c = command.Command(args.command)
+    previous_msg_id = None
+
+    while True:
+        now = str(datetime.datetime.now())
+        logger.info('executing command with time {}'.format(now))
+        diff = c.run(now)
+
+        if first_run:
+            print('[{}] first_run:'.format(now))
+            print(c.to_console())
+            subject = 'watch-diff first_run: {}'.format(args.command)
+            if e:
+                logger.info('sending first_run email to {}'.format(args.recipient))
+                msg_id = make_msgid()
+                e.send_email(subject, str(c), c.to_html(full_html=True), msg_id)
+                previous_msg_id = msg_id
+        elif diff:
+            print('[{}] diff:'.format(now))
+            print(diff.to_console())
+            subject = 'watch-diff diff: {}'.format(args.command)
+            if e:
+                logger.info('sending diff email to {}'.format(args.recipient))
+                msg_id = make_msgid()
+                e.send_email(subject, str(diff), diff.to_html(full_html=True), msg_id, previous_msg_id)
+                previous_msg_id = msg_id
+        else:
+            print('[{}] no diff'.format(now))
+
+        logger.info('sleeping for {} seconds'.format(args.interval))
+        time.sleep(args.interval)
+        first_run = False
+
+
+def main():
+    try:
+        _main()
+    except KeyboardInterrupt:
+        pass

watch_diff-0.7.0/watch_diff/command.py

@@ -0,0 +1,41 @@
+"""
+"""
+
+import datetime
+import subprocess
+
+from . import diff
+from . import format
+
+
+class Command(format.OutputFormatting):
+
+    def __init__(self, command):
+        self._command = command
+
+        self._previous_datetime = ''
+        self._previous_result = ''
+
+        self._current_datetime = ''
+        self._current_result = ''
+
+    def __bool__(self):
+        return bool(self._current_result)
+
+    def _format(self, formatter=format.DefaultFormatter):
+        return self._current_result
+
+    def _diff(self):
+        return diff.Diff(self._previous_result, self._current_result, self._previous_datetime, self._current_datetime)
+
+    def _run(self):
+        return subprocess.getoutput(self._command)
+
+    def run(self, now=None):
+        self._previous_datetime = self._current_datetime
+        self._previous_result = self._current_result
+
+        self._current_datetime = now or str(datetime.datetime.now())
+        self._current_result = self._run()
+
+        return self._diff()

watch_diff-0.7.0/watch_diff/diff.py

@@ -0,0 +1,31 @@
+"""
+"""
+
+import difflib
+
+from . import format
+
+
+class Diff(format.OutputFormatting):
+
+    def __init__(self, a, b, previous_datetime, current_datetime):
+        self._a = a
+        self._b = b
+        self._diff = '\n'.join(difflib.unified_diff(a.splitlines(), b.splitlines(), 'Previous', 'Current', previous_datetime, current_datetime, lineterm='')) or None
+
+    def __bool__(self):
+        return bool(self._diff)
+
+    def _format(self, formatter=format.DefaultFormatter):
+        lines = self._diff.splitlines()
+        output = []
+        for line in lines[:2]:
+            output.append('{}{}{}'.format(formatter.header_start, line, formatter.header_end))
+        for line in lines[2:]:
+            if line[0] == '+':
+                output.append('{}{}{}'.format(formatter.addition_start, line, formatter.addition_end))
+            elif line[0] == '-':
+                output.append('{}{}{}'.format(formatter.subtraction_start, line, formatter.subtraction_end))
+            else:
+                output.append(line)
+        return '\n'.join(output)

watch_diff-0.7.0/watch_diff/email.py

@@ -0,0 +1,84 @@
+"""
+"""
+
+import functools
+import logging
+import smtplib
+import socket
+import time
+
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.utils import make_msgid, formatdate
+
+
+logger = logging.getLogger(__name__)
+
+
+def _repeat_on_exceptions(num_times=3, *exceptions):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            count = 1
+            while True:
+                try:
+                    logger.info('running func: "{}", count: {}'.format(func.__name__, count))
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    if (not exceptions or e.__class__ in exceptions) and count < num_times:
+                        count += 1
+                        time.sleep(30)
+                        continue
+                    else:
+                        raise
+        return wrapper
+    return decorator
+
+
+class Email:
+
+    def __init__(self, smtp_host, smtp_port, smtp_user, smtp_pass, from_name, recipient):
+        self._smtp_host = smtp_host
+        self._smtp_port = smtp_port
+        self._smtp_user = smtp_user
+        self._smtp_pass = smtp_pass
+        self._from_name = from_name
+        self._recipient = recipient
+
+    @_repeat_on_exceptions(3, smtplib.SMTPServerDisconnected, socket.gaierror, socket.timeout)
+    def _smtp_connect(self, smtp_host, smtp_port):
+        return smtplib.SMTP(host=self._smtp_host, port=self._smtp_port)
+
+    @_repeat_on_exceptions(3, smtplib.SMTPAuthenticationError, socket.gaierror, socket.timeout)
+    def _smtp_login(self, session, smtp_user, smtp_pass):
+        session.login(self._smtp_user, self._smtp_pass)
+
+    def send_email(self, subject, text, html, msg_id=None, previous_msg_id=None):
+        logger.info('sending email')
+
+        msg = MIMEMultipart('alternative')
+
+        msg['From'] = '{} <{}>'.format(self._from_name, self._smtp_user)
+        msg['To'] = self._recipient
+        msg['Subject'] = subject
+        msg['Date'] = formatdate()
+        msg['Message-ID'] = msg_id or make_msgid()
+
+        if previous_msg_id:
+            msg['In-Reply-To'] = previous_msg_id
+
+        part1 = MIMEText(text, 'plain')
+        part2 = MIMEText(html, 'html')
+
+        msg.attach(part1)
+        msg.attach(part2)
+
+        s = self._smtp_connect(self._smtp_host, self._smtp_port)
+        s.ehlo()
+        s.starttls()
+        s.ehlo()
+        self._smtp_login(s, self._smtp_user, self._smtp_pass)
+        s.sendmail(self._smtp_user, self._recipient, msg.as_string())
+        s.quit()
+
+        logger.info('email sent successfully')

watch_diff-0.7.0/watch_diff/format.py

@@ -0,0 +1,51 @@
+"""
+"""
+
+class DefaultFormatter:
+    header_start = ''
+    header_end = ''
+    addition_start = ''
+    addition_end = ''
+    subtraction_start = ''
+    subtraction_end = ''
+
+class ConsoleFormatter(DefaultFormatter):
+    header_start = '\033[1m'
+    header_end = '\033[0m'
+    addition_start = '\033[92m'
+    addition_end = '\033[0m'
+    subtraction_start = '\033[91m'
+    subtraction_end = '\033[0m'
+
+class HTMLFormatter(DefaultFormatter):
+    header_start = '<b>'
+    header_end = '</b>'
+    addition_start = '<span style="color:green">'
+    addition_end = '</span>'
+    subtraction_start = '<span style="color:red">'
+    subtraction_end = '</span>'
+
+class OutputFormatting:
+
+    def __str__(self):
+        return self._format(DefaultFormatter)
+
+    def to_console(self):
+        return self._format(ConsoleFormatter)
+
+    def to_html(self, full_html=False):
+        partial_html = self._format(HTMLFormatter)
+        if not full_html:
+            return partial_html
+        else:
+            html_page = '''
+                <html>
+                    <body>
+                        <pre>
+                            {}
+                        </pre>
+                    </body>
+                </html>
+            '''
+            html_page = '\n'.join([l.strip() for l in html_page.splitlines()])
+            return html_page.format(partial_html)