devopsdriver 0.1.35__tar.gz → 0.1.36__tar.gz

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devopsdriver
-Version: 0.1.35
+Version: 0.1.36
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -52,7 +52,7 @@ Requires-Dist: setuptools==69.0.2
 Requires-Dist: azure-devops==7.1.0b4
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=starting...&color=inactive&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.35&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.35/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.36&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.36/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/README.md

@@ -1,5 +1,5 @@
 ![status sheild](https://img.shields.io/static/v1?label=status&message=starting...&color=inactive&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.35&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.35/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.36&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.36/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

devopsdriver-0.1.36/devopsdriver/__init__.py

@@ -0,0 +1,9 @@
+""" DevOps tools """
+
+from .azdo import Azure
+from .settings import Settings
+from .sendmail import send_email
+
+__version__ = "0.1.36"
+__author__ = "Marc Page"
+__credits__ = ""

{devopsdriver-0.1.35/devopsdriver/azure → devopsdriver-0.1.36/devopsdriver/azdo}/clients.py

@@ -11,7 +11,7 @@ from azure.devops.connection import Connection as AzureConnection
 from msrest.authentication import BasicAuthentication as MSBasicAuthentication
 
 from devopsdriver.settings import Settings
-from devopsdriver.azure.workitem.client import Client as WIClient
+from devopsdriver.azdo.workitem.client import Client as WIClient
 
 CONNECTION = AzureConnection
 AUTHENTICATION = MSBasicAuthentication

{devopsdriver-0.1.35/devopsdriver/azure → devopsdriver-0.1.36/devopsdriver/azdo}/workitem/client.py

@@ -6,8 +6,8 @@ from azure.devops.v7_1.work_item_tracking.models import Wiql as AzureWiql
 from azure.devops.v7_1.work_item_tracking.models import WorkItem as AzureWorkItem
 from azure.devops.v7_1.work_item_tracking.models import TeamContext
 from azure.devops.v7_1.work_item_tracking.models import WorkItemQueryResult
-from devopsdriver.azure.workitem import WorkItem
-from devopsdriver.azure.workitem.wiql import Wiql
+from devopsdriver.azdo.workitem import WorkItem
+from devopsdriver.azdo.workitem.wiql import Wiql
 
 
 class Client:

devopsdriver-0.1.36/devopsdriver/sendmail.py

@@ -0,0 +1,88 @@
+#!/usr/bin/env python3
+
+""" Ability to send emails with embedded images """
+from smtplib import SMTP as OS_SMTP, SMTP_SSL as OS_SMTP_SSL
+from email.mime.multipart import MIMEMultipart as OS_MIMEMultipart
+from email.mime.text import MIMEText as OS_MIMEText
+from email.mime.image import MIMEImage as OS_MIMEImage
+
+from devopsdriver.settings import Settings
+
+IMAGE_HEADERS = {".png": b"\x89PNG\r\n\x1a\n", ".jpg": b"\xff\xd8\xff"}
+
+# for testing
+MIMEMULTIPART = OS_MIMEMultipart
+MIMETEXT = OS_MIMEText
+MIMEIMAGE = OS_MIMEImage
+SMTP = OS_SMTP
+SMTPSSL = OS_SMTP_SSL
+
+
+def image_extension(data: bytes) -> str:
+    """Given image data, determine the file extension
+
+    Args:
+        data (bytes): The image binary data
+
+    Raises:
+        AttributeError: If the data type is not recognized
+
+    Returns:
+        str: The extension, like ".png"
+    """
+    for extension, header in IMAGE_HEADERS.items():
+        if data.startswith(header):
+            return extension
+
+    raise AttributeError("Image not a known format: " + ",".join(IMAGE_HEADERS))
+
+
+def send_email(
+    recipients: str | list[str],
+    subject: str,
+    html_body: str,
+    settings: Settings = None,
+    **image_data,
+):
+    """Sends an email with embedded images
+
+    Args:
+        recipients (str | list[str]): A single email address or a list of them
+        subject (str): Subject line
+        html_body (str): html formatted body. To reference an image in your
+                        body, <img src="cid:image1"> if you pass image1=png.read()
+        settings (Settings, optional): The settings object. Defaults to None.
+        image_data (dict, optional): keyword image names to binary image data
+    """
+    settings = Settings(__file__).key("secrets") if settings is None else settings
+    required = {"smtp.sender", "smtp.server", "smtp.port", "smtp.password"}
+    missing = {r for r in required if r not in settings}
+    assert not missing, (
+        ", ".join(missing) + " not found in:\n" + "\n".join(settings.search_files)
+    )
+    sender = settings["smtp.sender"]
+    username = settings.get("smtp.username", sender)
+    message = MIMEMULTIPART()
+    message["Subject"] = subject
+    message["From"] = sender
+    message["To"] = ", ".join(
+        [recipients] if isinstance(recipients, str) else recipients
+    )
+    message.attach(MIMETEXT(html_body, "html"))
+    connection_type = SMTPSSL if settings.get("smtp.ssl", True) else SMTP
+
+    for name, binary_data in image_data.items():
+        image = MIMEIMAGE(binary_data)
+        image.add_header("Content-ID", f"<{name}>")
+        image.add_header(
+            "Content-Disposition",
+            "inline",
+            filename=name + image_extension(binary_data),
+        )
+        message.attach(image)
+
+    with connection_type(settings["smtp.server"], settings["smtp.port"]) as smtp:
+        smtp.set_debuglevel(False)
+        smtp.login(username, settings["smtp.password"])
+        smtp.sendmail(sender, recipients, message.as_string())
+        smtp.quit()

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/devopsdriver/settings.py

@@ -361,10 +361,17 @@ class Settings:
 
 def main() -> None:
     """Get settings values"""
-    settings = Settings(__file__, dirname(dirname(__file__))).key("secrets")
-
     args = list(ARGV[1:])
 
+    if not args or "--help" in args or "-h" in args:
+        PRINT("pass in settings to see if they are set and to what value")
+        PRINT("You can pass dotted names to get inner values, like smpt.server")
+        PRINT("You can pass --secrets to set keychain values that have not been set")
+        PRINT("You can also pass --help or -h to get this message")
+        return
+
+    settings = Settings(__file__, dirname(dirname(__file__))).key("secrets")
+
     if "--secrets" in args:
         args.remove("--secrets")
 
@@ -380,7 +387,7 @@ def main() -> None:
                 PRINT("\tValue set")
 
     for arg in args:
-        PRINT(settings.get(arg))
+        PRINT(f"{settings.get(arg)}")
 
 
 if __name__ == "__main__":

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/devopsdriver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devopsdriver
-Version: 0.1.35
+Version: 0.1.36
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -52,7 +52,7 @@ Requires-Dist: setuptools==69.0.2
 Requires-Dist: azure-devops==7.1.0b4
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=starting...&color=inactive&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.35&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.35/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.36&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.36/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/devopsdriver.egg-info/SOURCES.txt

@@ -2,20 +2,22 @@ LICENSE
 README.md
 pyproject.toml
 devopsdriver/__init__.py
+devopsdriver/sendmail.py
 devopsdriver/settings.py
 devopsdriver.egg-info/PKG-INFO
 devopsdriver.egg-info/SOURCES.txt
 devopsdriver.egg-info/dependency_links.txt
 devopsdriver.egg-info/requires.txt
 devopsdriver.egg-info/top_level.txt
-devopsdriver/azure/__init__.py
-devopsdriver/azure/clients.py
-devopsdriver/azure/workitem/__init__.py
-devopsdriver/azure/workitem/client.py
-devopsdriver/azure/workitem/wiql.py
-devopsdriver/azure/workitem/workitem.py
+devopsdriver/azdo/__init__.py
+devopsdriver/azdo/clients.py
+devopsdriver/azdo/workitem/__init__.py
+devopsdriver/azdo/workitem/client.py
+devopsdriver/azdo/workitem/wiql.py
+devopsdriver/azdo/workitem/workitem.py
 tests/test_azure_clients.py
 tests/test_azure_workitem.py
 tests/test_azure_workitem_client.py
 tests/test_azure_workitem_wiql.py
+tests/test_sendmail.py
 tests/test_settings.py

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/tests/test_azure_clients.py

@@ -11,7 +11,7 @@ from os.path import join
 from helpers import setup_settings, write
 
 from devopsdriver import Azure
-from devopsdriver.azure import clients
+from devopsdriver.azdo import clients
 
 
 class MockConnection:  # pylint: disable=too-few-public-methods

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/tests/test_azure_workitem.py

@@ -2,7 +2,7 @@
 
 """ Test work item """
 
-from devopsdriver.azure import WorkItem
+from devopsdriver.azdo import WorkItem
 
 
 class MockAzureWorkItem:

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/tests/test_azure_workitem_client.py

@@ -4,8 +4,8 @@
 
 from types import SimpleNamespace
 
-from devopsdriver.azure.workitem.client import Client
-from devopsdriver.azure import Wiql, Equal
+from devopsdriver.azdo.workitem.client import Client
+from devopsdriver.azdo import Wiql, Equal
 
 
 class MockClient:  # pylint: disable=too-few-public-methods

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/tests/test_azure_workitem_wiql.py

@@ -4,11 +4,11 @@
 
 from datetime import date, datetime
 
-from devopsdriver.azure import Wiql
-from devopsdriver.azure import Ascending, Descending, Value
-from devopsdriver.azure import IsEmpty, IsNotEmpty, And, Or
-from devopsdriver.azure import GreaterThan, LessThan, Equal, NotEqual
-from devopsdriver.azure import GreaterThanOrEqual, LessThanOrEqual
+from devopsdriver.azdo import Wiql
+from devopsdriver.azdo import Ascending, Descending, Value
+from devopsdriver.azdo import IsEmpty, IsNotEmpty, And, Or
+from devopsdriver.azdo import GreaterThan, LessThan, Equal, NotEqual
+from devopsdriver.azdo import GreaterThanOrEqual, LessThanOrEqual
 
 
 def test_no_params() -> None:

devopsdriver-0.1.36/tests/test_sendmail.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+
+""" Test sendmail """
+
+from devopsdriver import sendmail  # for debugging
+from devopsdriver import send_email
+
+
+class MockMultipart(dict):
+    """Mock mime multipart"""
+
+    def __init__(self):
+        self.objects = []
+        super().__init__()
+
+    def attach(self, thing):
+        """mock attaching"""
+        self.objects.append(thing)
+
+    def as_string(self) -> str:
+        """don't actually convert to string so we can check fields"""
+        return self
+
+
+class MockText:
+    """mock mime text"""
+
+    def __init__(self, text: str, kind: str):
+        self.text = text
+        self.kind = kind
+
+
+class MockImage:
+    """mock mime image"""
+
+    def __init__(self, data: bytes):
+        self.data = data
+        self.headers = {}
+        self.filenames = {}
+
+    def add_header(self, key, value, filename=None):
+        """store headers and filenames (if they have them)"""
+        self.headers[key] = value
+
+        if filename:
+            self.filenames[key] = filename
+
+
+class MockSmtp:
+    """mock smtp and smpt_ssl"""
+
+    def __init__(self, server: str, port: int):
+        self.server = server
+        self.port = port
+        self.debuglevel = None
+        self.username = None
+        self.password = None
+        self.sender = None
+        self.recipients = None
+        self.message = None
+
+    def set_debuglevel(self, level: bool):
+        """store that we've set the debug level"""
+        self.debuglevel = level
+
+    def login(self, username: str, password: str):
+        """store the credentials"""
+        self.username = username
+        self.password = password
+
+    def sendmail(self, sender: str, recipients: list[str], message: str):
+        """store what we're sending"""
+        self.sender = sender
+        self.recipients = recipients
+        self.message = message
+
+    def quit(self):
+        """on quit check everything"""
+        assert self.server == "smtp.com", self.server
+        assert self.port == 1234, self.port
+        assert not self.debuglevel and self.debuglevel is not None, self.debuglevel
+        assert self.username == "from@domain.com", self.username
+        assert self.password == "setec astronomy", self.password
+        assert self.sender == "from@domain.com", self.sender
+        assert self.recipients == "to@domain.com", self.recipients
+        assert len(self.message.objects) == 2, self.message.objects
+        assert self.message.objects[0].text == "body", self.message.objects[0].text
+        assert self.message.objects[0].kind == "html", self.message.objects[0].kind
+        assert (
+            self.message.objects[1].data == b"\x89PNG\r\n\x1a\n0000"
+        ), self.message.objects[1].data
+        assert (
+            self.message.objects[1].headers["Content-ID"] == "<image1>"
+        ), self.message.objects[1].headers["Content-ID"]
+        assert (
+            self.message.objects[1].headers["Content-Disposition"] == "inline"
+        ), self.message.objects[1].headers["Content-Disposition"]
+        assert (
+            self.message.objects[1].filenames["Content-Disposition"] == "image1.png"
+        ), self.message.objects[1].filenames["Content-Disposition"]
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        return False
+
+
+def test_basic() -> None:
+    """test basics"""
+    sendmail.MIMEMULTIPART = MockMultipart
+    sendmail.MIMETEXT = MockText
+    sendmail.MIMEIMAGE = MockImage
+    sendmail.SMTP = MockSmtp
+    sendmail.SMTPSSL = MockSmtp
+    settings = {
+        "smtp.sender": "from@domain.com",
+        "smtp.server": "smtp.com",
+        "smtp.port": 1234,
+        "smtp.password": "setec astronomy",
+    }
+    send_email(
+        "to@domain.com", "subject", "body", settings, image1=b"\x89PNG\r\n\x1a\n0000"
+    )
+
+
+def test_unknown_image_type() -> None:
+    """test basics"""
+    sendmail.MIMEMULTIPART = MockMultipart
+    sendmail.MIMETEXT = MockText
+    sendmail.MIMEIMAGE = MockImage
+    sendmail.SMTP = MockSmtp
+    sendmail.SMTPSSL = MockSmtp
+    settings = {
+        "smtp.sender": "from@domain.com",
+        "smtp.server": "smtp.com",
+        "smtp.port": 1234,
+        "smtp.password": "setec astronomy",
+    }
+
+    try:
+        send_email("to@domain.com", "subject", "body", settings, image1=b"bwahaha")
+        raise AssertionError("We should have thrown")
+
+    except AttributeError:
+        pass
+
+
+if __name__ == "__main__":
+    test_unknown_image_type()
+    test_basic()

{devopsdriver-0.1.35 → devopsdriver-0.1.36}/tests/test_settings.py

@@ -9,7 +9,8 @@ from itertools import product
 
 from helpers import setup_settings, ensure, write
 
-import devopsdriver.settings as settings
+from devopsdriver import settings  # debug access
+from devopsdriver import Settings
 
 
 def __setup_files(directory: str, dir1: str, dir2: str) -> None:
@@ -40,9 +41,9 @@ def __setup_files(directory: str, dir1: str, dir2: str) -> None:
         <pref>/test.yaml w
         <pref>/test.json x
     """
-    lin_dir = ensure(settings.Settings.PREF_DIR["Linux"])
-    mac_dir = ensure(settings.Settings.PREF_DIR["Darwin"])
-    win_dir = ensure(settings.Settings.PREF_DIR["Windows"])
+    lin_dir = ensure(Settings.PREF_DIR["Linux"])
+    mac_dir = ensure(Settings.PREF_DIR["Darwin"])
+    win_dir = ensure(Settings.PREF_DIR["Windows"])
     letters = list(ascii_lowercase)
 
     for name in ("test", "main"):
@@ -90,9 +91,7 @@ def test_basic():
             }
             settings.ARGV = ["exe", "--beta", "bbcli", "--zeta", "zzcli"]
             opts = (
-                settings.Settings(
-                    join(base_dir, "main.py"), dir1, dir2, aa=1, bb=2, cc=3
-                )
+                Settings(join(base_dir, "main.py"), dir1, dir2, aa=1, bb=2, cc=3)
                 .cli("bb", "--beta")
                 .cli("zz", "--zeta")
                 .env("aa", "alpha")
@@ -204,11 +203,7 @@ def test_cli_env_in_yaml():
             "--delta",
             "cli dd",
         ]
-        opts = (
-            settings.Settings(join(base_dir, "main.py"), aa="code aa")
-            .cli("cli")
-            .env("env")
-        )
+        opts = Settings(join(base_dir, "main.py"), aa="code aa").cli("cli").env("env")
         assert opts["aa"] == "code aa", opts["aa"]
         assert opts["bb"] == "cli bb", opts["bb"]
         assert opts["dd"] == "cli dd", opts["dd"]
@@ -237,11 +232,7 @@ def test_environ_values():
             "HOME": "sweet home",
             "APPDIR": "app data dir",
         }
-        opts = (
-            settings.Settings(join(base_dir, "main.py"), aa="code aa")
-            .cli("cli")
-            .env("env")
-        )
+        opts = Settings(join(base_dir, "main.py"), aa="code aa").cli("cli").env("env")
         assert opts["output"] == "sweet home/reports", opts["output"]
         assert opts["settings"] == "app data dir/settings.json", opts["settings"]
         assert opts["value"] == "testing ${noenv} for noenv", opts["value"]
@@ -256,6 +247,15 @@ def test_main():
         settings.main()
 
 
+def test_main_help():
+    """test the main entry point"""
+    with TemporaryDirectory() as working_dir:
+        setup_settings(shared="test", Linux=join(working_dir, "Linux"))
+        settings.ARGV = ["ignore", "--help"]
+        write(join(working_dir, "Linux", "test.yml"), test=3)
+        settings.main()
+
+
 def test_secret():
     """test os secret storage"""
     with TemporaryDirectory() as working_dir:
@@ -270,9 +270,7 @@ def test_secret():
         )
         settings.GET_PASSWORD = lambda s, e: passwords.get(s, {}).get(e, None)
         write(join(base_dir, "main.yml"), password="main")
-        opts = settings.Settings(join(base_dir, "main.py")).key(
-            "password", "system/john"
-        )
+        opts = Settings(join(base_dir, "main.py")).key("password", "system/john")
         assert opts["password"] == "setec astronomy", opts["password"]
 
 

devopsdriver-0.1.35/devopsdriver/__init__.py

@@ -1,7 +0,0 @@
-""" DevOps tools """
-
-from .azure import Azure
-
-__version__ = "0.1.35"
-__author__ = "Marc Page"
-__credits__ = ""