machineconfig 2.0__py3-none-any.whl → 2.1__py3-none-any.whl

machineconfig/utils/links.py

@@ -1,4 +1,4 @@
-from machineconfig.utils.path_reduced import P as PathExtended, PLike
+from machineconfig.utils.path_reduced import PathExtended as PathExtended, PLike
 from machineconfig.utils.utils2 import randstr
 from rich.console import Console
 from rich.panel import Panel
@@ -19,6 +19,7 @@ def build_links(target_paths: list[tuple[PLike, str]], repo_root: PLike):
         target_dirs_filtered.append((a_dir_obj, a_name))
 
     import git
+
     repo = git.Repo(repo_root, search_parent_directories=True)
     root_maybe = repo.working_tree_dir
     assert root_maybe is not None
@@ -31,7 +32,8 @@ def build_links(target_paths: list[tuple[PLike, str]], repo_root: PLike):
         links_path = repo_root_obj.joinpath("links", a_name)
         links_path.symlink_to(target=a_target_path)
 
-def symlink_func(this: PathExtended, to_this: PathExtended, prioritize_to_this: bool=True):
+
+def symlink_func(this: PathExtended, to_this: PathExtended, prioritize_to_this: bool = True):
     """helper function. creates a symlink from `this` to `to_this`.
     What can go wrong?
     depending on this and to_this existence, one will be prioretized depending on overwrite value.
@@ -39,15 +41,19 @@ def symlink_func(this: PathExtended, to_this: PathExtended, prioritize_to_this:
     False means to_this will potentially be overwittten."""
     this = PathExtended(this).expanduser().absolute()
     to_this = PathExtended(to_this).expanduser().absolute()
-    if this.is_symlink(): this.delete(sure=True)  # delete if it exists as symblic link, not a concrete path.
+    if this.is_symlink():
+        this.delete(sure=True)  # delete if it exists as symblic link, not a concrete path.
     if this.exists():  # this is a problem. It will be resolved via `overwrite`
         if prioritize_to_this is True:  # it *can* be deleted, but let's look at target first.
             if to_this.exists():  # this exists, to_this as well. to_this is prioritized.
                 this.append(f".orig_{randstr()}", inplace=True)  # rename is better than deletion
-            else: this.move(path=to_this)  # this exists, to_this doesn't. to_this is prioritized.
+            else:
+                this.move(path=to_this)  # this exists, to_this doesn't. to_this is prioritized.
         elif prioritize_to_this is False:  # don't sacrefice this, sacrefice to_this.
-            if to_this.exists(): this.move(path=to_this, overwrite=True)  # this exists, to_this as well, this is prioritized.   # now we are readly to make the link
-            else: this.move(path=to_this)  # this exists, to_this doesn't, this is prioritized.
+            if to_this.exists():
+                this.move(path=to_this, overwrite=True)  # this exists, to_this as well, this is prioritized.   # now we are readly to make the link
+            else:
+                this.move(path=to_this)  # this exists, to_this doesn't, this is prioritized.
     else:  # this doesn't exist.
         if not to_this.exists():
             to_this.parent.mkdir(parents=True, exist_ok=True)
@@ -58,18 +64,23 @@ def symlink_func(this: PathExtended, to_this: PathExtended, prioritize_to_this:
     except Exception as ex:
         console.print(Panel(f"❌ ERROR | Failed at linking {this} ➡️  {to_this}. Reason: {ex}", title="Error", expand=False))
 
-def symlink_copy(this: PathExtended, to_this: PathExtended, prioritize_to_this: bool=True):
+
+def symlink_copy(this: PathExtended, to_this: PathExtended, prioritize_to_this: bool = True):
     this = PathExtended(this).expanduser().absolute()
     to_this = PathExtended(to_this).expanduser().absolute()
-    if this.is_symlink(): this.delete(sure=True)  # delete if it exists as symblic link, not a concrete path.
+    if this.is_symlink():
+        this.delete(sure=True)  # delete if it exists as symblic link, not a concrete path.
     if this.exists():  # this is a problem. It will be resolved via `overwrite`
         if prioritize_to_this is True:  # it *can* be deleted, but let's look at target first.
             if to_this.exists():  # this exists, to_this as well. to_this is prioritized.
                 this.append(f".orig_{randstr()}", inplace=True)  # rename is better than deletion
-            else: this.move(path=to_this)  # this exists, to_this doesn't. to_this is prioritized.
+            else:
+                this.move(path=to_this)  # this exists, to_this doesn't. to_this is prioritized.
         elif prioritize_to_this is False:  # don't sacrefice this, sacrefice to_this.
-            if to_this.exists(): this.move(path=to_this, overwrite=True)  # this exists, to_this as well, this is prioritized.   # now we are readly to make the link
-            else: this.move(path=to_this)  # this exists, to_this doesn't, this is prioritized.
+            if to_this.exists():
+                this.move(path=to_this, overwrite=True)  # this exists, to_this as well, this is prioritized.   # now we are readly to make the link
+            else:
+                this.move(path=to_this)  # this exists, to_this doesn't, this is prioritized.
     else:  # this doesn't exist.
         if not to_this.exists():
             to_this.parent.mkdir(parents=True, exist_ok=True)

machineconfig/utils/notifications.py

@@ -0,0 +1,197 @@
+
+"""Notifications Module
+"""
+
+# from crocodile.core import install_n_import
+# from crocodile.file_management import P, Read
+from pathlib import Path
+# from crocodile.meta import RepeatUntilNoException
+import smtplib
+import imaplib
+# from email import message
+# from email import encoders
+# from email.mime.base import MIMEBase
+from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
+from typing import Optional, Any, Union, Literal
+from markdown import markdown
+
+
+
+def download_to_memory(path: Path, allow_redirects: bool = True, timeout: Optional[float] = None, params: Any = None) -> 'Any':
+    import requests
+    return requests.get(path.as_posix().replace("https:/", "https://").replace("http:/", "http://"), allow_redirects=allow_redirects, timeout=timeout, params=params)  # Alternative: from urllib import request; request.urlopen(url).read().decode('utf-8').
+
+
+def get_github_markdown_css() -> str:
+    pp = r'https://raw.githubusercontent.com/sindresorhus/github-markdown-css/main/github-markdown-dark.css'
+    return download_to_memory(Path(pp)).text
+
+
+def md2html(body: str):
+    gh_style = Path(__file__).parent.joinpath("gh_style.css").read_text()
+    return f"""
+<!DOCTYPE html>
+<html>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<style>
+{gh_style}
+    .markdown-body {{
+        box-sizing: border-box;
+        min-width: 200px;
+        max-width: 1350px;
+        margin: 0 auto;
+        padding: 45px;
+        line-height: 1.8;
+    }}
+    @media (max-width: 767px) {{.markdown-body {{padding: 15px;}}
+    }}
+</style>
+<body>
+<div class="markdown-body">
+{markdown(body)}
+</div>
+</body>
+</html>"""
+
+
+class Email:
+    @staticmethod
+    def get_source_of_truth():
+        path = Path.home().joinpath("dotfiles/machineconfig/emails.ini")
+        if not path.exists():
+            raise FileNotFoundError(f"""File not found: {path}. It should be an ini file with this structure
+[resend]
+api_key = xxx
+
+[config1]
+email_add = a@b.com
+password = 123
+smtp_host = a@b.com
+smtp_port = 465
+imap_host = b@c.com
+imap_port = 465
+encryption = ssl
+
+""")
+
+        if not Path(path).exists() or Path(path).is_dir(): raise FileNotFoundError(f"File not found or is a directory: {path}")
+        import configparser
+        res = configparser.ConfigParser()
+        res.read(filenames=[str(path)], encoding=None)
+        return res
+
+    def __init__(self, config: dict[str, Any]):
+        self.config = config
+        from smtplib import SMTP_SSL, SMTP
+        self.server: Union[SMTP_SSL, SMTP]
+        if config['encryption'].lower() == "ssl": self.server = smtplib.SMTP_SSL(host=self.config["smtp_host"], port=self.config["smtp_port"])
+        elif config['encryption'].lower() == "tls": self.server = smtplib.SMTP(host=self.config["smtp_host"], port=self.config["smtp_port"])
+        self.server.login(self.config['email_add'], password=self.config["password"])
+
+    def send_message(self, to: str, subject: str, body: str, txt_to_html: bool = True, attachments: Optional[list[Any]] = None):
+        _ = attachments
+        body += "\n\nThis is an automated email sent via crocodile.comms script."
+        # msg = message.EmailMessage()
+        msg = MIMEMultipart("alternative")
+        msg["subject"] = subject
+        msg["From"] = self.config['email_add']
+        msg["To"] = to
+        # msg['Content-Type'] = "text/html"
+        # msg.set_content(body)
+
+        # <link rel="stylesheet" href="github-markdown.css">
+        # <link type="text/css" rel="stylesheet" href="https://raw.githubusercontent.com/sindresorhus/github-markdown-css/main/github-markdown-dark.css" />
+
+        if txt_to_html: body = md2html(body=body)
+        msg.attach(MIMEText(body, "html"))
+        # if attachments is None: attachments = []  # see: https://fedingo.com/how-to-send-html-mail-with-attachment-using-python/
+        # for attachment in attachmenthrs: msg.attach(attachment.read_bytes(), filename=attachment.stem, maintype="image", subtype=attachment.suffix)
+        # for attachment in attachments: msg.attach(attachment.read_bytes(), filename=attachment.stem, maintype="application", subtype="octet-stream")
+
+        self.server.send_message(msg)
+
+    @staticmethod
+    def manage_folders(email_add: str, pwd: str):
+        server = imaplib.IMAP4()
+        server.starttls()
+        server.login(email_add, password=pwd)
+
+    def send_email(self, to_addrs: str, msg: str): return self.server.sendmail(from_addr=self.config['email_add'], to_addrs=to_addrs, msg=msg)
+    def close(self): self.server.quit()    # Closing is vital as many servers do not allow mutiple connections.
+
+    @staticmethod
+    def send_and_close(config_name: Optional[str], to: str, subject: str, body: str) -> Any:
+        """If config_name is None, it sends from a generic email address."""
+        if config_name is None:
+            raise NotImplementedError("Sending email without a config_name is not implemented. You need to create an emails.ini file in ~/dotfiles/machineconfig/ with your email configuration. See the docstring of the get_source_of_truth method for more information.")
+            # config = Email.get_source_of_truth()
+            # try:
+            #     api_key = config['resend']['api_key']
+            #     to = config["resend"]["signup_email"]
+            # except KeyError as ke:
+            #     msggg = "You did not pass a config_name, therefore, the default is to use resend, however, you need to add your resend api key to the emails.ini file."
+            #     raise KeyError(msggg) from ke
+
+            # _resend = install_n_import("resend")
+            # import resend  # type: ignore
+            # resend.api_key = api_key
+            # r = resend.Emails.send({
+            # "from": "onboarding@resend.dev",
+            # "to": to,
+            # "subject": subject,
+            # "html": md2html(body=body)
+            # })
+            # return r
+
+        else:
+            config = dict(Email.get_source_of_truth()[config_name])
+            tmp = Email(config=config)
+            tmp.send_message(to=to, subject=subject, body=body)
+            tmp.close()
+
+    @staticmethod
+    def send_m365(to: list[str], subject: str, body: Optional[str], body_file: Optional[str], body_content_type: Literal["HTML", "Text"], attachments: Optional[list[Path]] = None) -> None:
+        if body_file is not None:
+            assert body is None, "You cannot pass both body and body_file."
+            body_file_path = Path(body_file)
+            assert body_file_path.exists(), f"File not found: {body_file_path}"
+        else:
+            body_file_path = None
+            assert body is not None, "You must pass either body or body_file."
+        from crocodile.meta import Terminal
+        to_str = ",".join(to)
+        attachments_str = " ".join([f"--attachment {str(p)}" for p in attachments]) if attachments is not None else ""
+
+        if body_file is not None:
+            body_arg = f"--bodyContents @{body_file_path}"
+        else:
+            body_arg = f'"{body}"'
+        cmd = f"""m365 outlook mail send --verbose --saveToSentItems --importance normal --bodyContentType {body_content_type} --bodyContents {body_arg} --subject "{subject}" --to {to_str} {attachments_str}"""
+        response = Terminal().run(cmd, shell="powershell")
+        response.print(desc="Email sending response")
+
+
+# class PhoneNotification:  # security concerns: avoid using this.
+#     def __init__(self, token: Optional[str]):
+#         if token is None:
+#             path = P.home().joinpath("dotfiles/machineconfig/phone_notification.ini")
+#             ini = Read.ini(path)
+#             token_ = ini["default"]["token"]
+#         else:
+#             token_ = token
+#         pushbullet = install_n_import("pushbullet")
+#         self.api = pushbullet.Pushbullet(token_)
+#     def send_notification(self, title: str = "Note From Python", body: str = "A notfication"):
+#         self.api.push_note(title=title, body=body)
+#     @staticmethod
+#     def open_website():
+#         P(r"https://www.pushbullet.com/")()
+#     @staticmethod  # https://www.youtube.com/watch?v=tbzPcKRZlHg
+#     def try_me(bulletpoint_token: str):
+#         n = PhoneNotification(bulletpoint_token)
+#         n.send_notification()
+
+
+if __name__ == '__main__':
+    pass

machineconfig/utils/options.py

@@ -1,4 +1,3 @@
-
 from pathlib import Path
 from rich.text import Text
 from rich.panel import Panel
@@ -10,18 +9,20 @@ from typing import Optional, Union, TypeVar, Iterable
 T = TypeVar("T")
 
 
-
 def check_tool_exists(tool_name: str, install_script: Optional[str] = None) -> bool:
     if platform.system() == "Windows":
         tool_name = tool_name.replace(".exe", "") + ".exe"
 
-    if platform.system() == "Windows": cmd = "where.exe"
-    elif platform.system() in ["Linux", "Darwin"]: cmd = "which"
-    else: raise NotImplementedError(f"platform {platform.system()} not implemented")
+    if platform.system() == "Windows":
+        cmd = "where.exe"
+    elif platform.system() in ["Linux", "Darwin"]:
+        cmd = "which"
+    else:
+        raise NotImplementedError(f"platform {platform.system()} not implemented")
 
     try:
         _tmp = subprocess.check_output([cmd, tool_name], stderr=subprocess.DEVNULL)
-        res: bool=True
+        res: bool = True
     except (subprocess.CalledProcessError, FileNotFoundError):
         res = False
     if res is False and install_script is not None:
@@ -38,25 +39,20 @@ def check_tool_exists(tool_name: str, install_script: Optional[str] = None) -> b
     return res
 
 
-def choose_one_option(options: Iterable[T], header: str="", tail: str="", prompt: str="", msg: str="",
-                      default: Optional[T] = None, fzf: bool=False, custom_input: bool=False) -> T:
-    choice_key = display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt,
-                                 default=default, fzf=fzf, multi=False, custom_input=custom_input)
+def choose_one_option(options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", msg: str = "", default: Optional[T] = None, fzf: bool = False, custom_input: bool = False) -> T:
+    choice_key = display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=False, custom_input=custom_input)
     assert not isinstance(choice_key, list)
     return choice_key
 
 
-def choose_multiple_options(options: Iterable[T], header: str="", tail: str="", prompt: str="", msg: str="",
-                            default: Optional[T] = None, custom_input: bool=False) -> list[T]:
-    choice_key = display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt,
-                                 default=default, fzf=True, multi=True,
-                                 custom_input=custom_input)
-    if isinstance(choice_key, list): return choice_key
+def choose_multiple_options(options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", msg: str = "", default: Optional[T] = None, custom_input: bool = False) -> list[T]:
+    choice_key = display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=True, multi=True, custom_input=custom_input)
+    if isinstance(choice_key, list):
+        return choice_key
     return [choice_key]
 
 
-def display_options(msg: str, options: Iterable[T], header: str="", tail: str="", prompt: str="",
-                    default: Optional[T] = None, fzf: bool=False, multi: bool=False, custom_input: bool=False) -> Union[T, list[T]]:
+def display_options(msg: str, options: Iterable[T], header: str = "", tail: str = "", prompt: str = "", default: Optional[T] = None, fzf: bool = False, multi: bool = False, custom_input: bool = False) -> Union[T, list[T]]:
     # TODO: replace with https://github.com/tmbo/questionary
     # # also see https://github.com/charmbracelet/gum
     tool_name = "fzf"
@@ -65,6 +61,7 @@ def display_options(msg: str, options: Iterable[T], header: str="", tail: str=""
     console = Console()
     if fzf and check_tool_exists(tool_name):
         from pyfzf.pyfzf import FzfPrompt
+
         fzf_prompt = FzfPrompt()
         nl = "\n"
         choice_string_multi: list[str] = fzf_prompt.prompt(choices=options_strings, fzf_options=("--multi" if multi else "") + f' --prompt "{prompt.replace(nl, " ")}" ')  # --border-label={msg.replace(nl, ' ')}")
@@ -84,7 +81,8 @@ def display_options(msg: str, options: Iterable[T], header: str="", tail: str=""
         if default is not None:
             assert default in options, f"Default `{default}` option not in options `{list(options)}`"
             default_msg = Text(" <<<<-------- DEFAULT", style="bold red")
-        else: default_msg = Text("")
+        else:
+            default_msg = Text("")
         txt = Text("\n" + msg + "\n")
         for idx, key in enumerate(options):
             txt = txt + Text(f"{idx:2d} ", style="bold blue") + str(key) + (default_msg if default is not None and default == key else "") + "\n"
@@ -111,7 +109,8 @@ def display_options(msg: str, options: Iterable[T], header: str="", tail: str=""
                 if choice_string in options_strings:  # string input
                     choice_idx = options_strings.index(choice_one)  # type: ignore
                     choice_one = list(options)[choice_idx]
-                elif custom_input: return str(choice_string)  # type: ignore
+                elif custom_input:
+                    return str(choice_string)  # type: ignore
                 else:
                     _ = ie
                     # raise ValueError(f"Unknown choice. {choice_string}") from ie
@@ -129,7 +128,8 @@ def display_options(msg: str, options: Iterable[T], header: str="", tail: str=""
                     console.print(Panel(f"❓ Unknown choice: '{choice_string}'", title="Error", expand=False))
                     return display_options(msg=msg, options=options, header=header, tail=tail, prompt=prompt, default=default, fzf=fzf, multi=multi, custom_input=custom_input)
         console.print(Panel(f"✅ Selected option {choice_idx}: {choice_one}", title="Selected", expand=False))
-        if multi: return [choice_one]
+        if multi:
+            return [choice_one]
     return choice_one
 
 
@@ -141,16 +141,22 @@ def choose_cloud_interactively() -> str:
     if isinstance(tmp, str):
         remotes: list[str] = [x.replace(":", "") for x in tmp.splitlines()]
 
-    else: raise ValueError(f"Got {tmp} from rclone listremotes")
+    else:
+        raise ValueError(f"Got {tmp} from rclone listremotes")
     if len(remotes) == 0:
         raise RuntimeError("You don't have remotes. Configure your rclone first to get cloud services access.")
     cloud: str = choose_one_option(msg="WHICH CLOUD?", options=list(remotes), default=remotes[0], fzf=True)
     console.print(Panel(f"✅ SELECTED CLOUD | {cloud}", border_style="bold blue", expand=False))
     return cloud
 
+
 def get_ssh_hosts() -> list[str]:
     from paramiko import SSHConfig
+
     c = SSHConfig()
     c.parse(open(Path.home().joinpath(".ssh/config"), encoding="utf-8"))
     return list(c.get_hostnames())
-def choose_ssh_host(multi: bool=True): return display_options(msg="", options=get_ssh_hosts(), multi=multi, fzf=True)
+
+
+def choose_ssh_host(multi: bool = True):
+    return display_options(msg="", options=get_ssh_hosts(), multi=multi, fzf=True)

machineconfig/utils/path.py

@@ -1,4 +1,4 @@
-from machineconfig.utils.path_reduced import P as PathExtended
+from machineconfig.utils.path_reduced import PathExtended as PathExtended
 from machineconfig.utils.options import choose_one_option
 from rich.console import Console
 from rich.panel import Panel
@@ -11,12 +11,14 @@ from pathlib import Path
 T = TypeVar("T")
 console = Console()
 
+
 def sanitize_path(a_path: PathExtended) -> PathExtended:
     path = PathExtended(a_path)
     if Path.cwd() == Path.home() and not path.exists():
         result = input("Current working directory is home, and passed path is not full path, are you sure you want to continue, [y]/n? ") or "y"
         if result == "y":
             import sys
+
             sys.exit()
     if path.as_posix().startswith("/home") or path.as_posix().startswith("/Users"):
         if platform.system() == "Windows":  # path copied from Linux/Mac to Windows
@@ -70,7 +72,8 @@ def match_file_name(sub_string: str, search_root: PathExtended) -> PathExtended:
     search_root_obj = search_root.absolute()
     # assume subscript is filename only, not a sub_path. There is no need to fzf over the paths.
     filename_matches, partial_path_matches = find_scripts(search_root_obj, sub_string)
-    if len(filename_matches) == 1: return PathExtended(filename_matches[0])
+    if len(filename_matches) == 1:
+        return PathExtended(filename_matches[0])
     console.print(Panel(f"Partial filename match with case-insensitivity failed. This generated #{len(filename_matches)} results.", title="Search", expand=False))
     if len(filename_matches) < 10:
         print("\n".join([a_potential_match.as_posix() for a_potential_match in filename_matches]))
@@ -78,7 +81,8 @@ def match_file_name(sub_string: str, search_root: PathExtended) -> PathExtended:
         print("Try to narrow down filename_matches search by case-sensitivity.")
         # let's see if avoiding .lower() helps narrowing down to one result
         reduced_scripts = [a_potential_match for a_potential_match in filename_matches if sub_string in a_potential_match.name]
-        if len(reduced_scripts) == 1: return PathExtended(reduced_scripts[0])
+        if len(reduced_scripts) == 1:
+            return PathExtended(reduced_scripts[0])
         elif len(reduced_scripts) > 1:
             choice = choose_one_option(msg="Multiple matches found", options=reduced_scripts, fzf=True)
             return PathExtended(choice)
@@ -92,18 +96,21 @@ def match_file_name(sub_string: str, search_root: PathExtended) -> PathExtended:
     elif len(partial_path_matches) > 1:
         print("Try to narrow down partial_path_matches search by case-sensitivity.")
         reduced_scripts = [a_potential_match for a_potential_match in partial_path_matches if sub_string in a_potential_match.as_posix()]
-        if len(reduced_scripts) == 1: return PathExtended(reduced_scripts[0])
+        if len(reduced_scripts) == 1:
+            return PathExtended(reduced_scripts[0])
         print(f"Result: This still generated {len(reduced_scripts)} results.")
     try:
         fzf_cmd = f"cd '{search_root_obj}'; fd --type file --strip-cwd-prefix | fzf --ignore-case --exact --query={sub_string}"
         console.print(Panel(f"🔍 Second attempt: SEARCH STRATEGY | Using fd to search for '{sub_string}' in '{search_root_obj}' ...\n{fzf_cmd}", title="Search Strategy", expand=False))
-        search_res_raw = subprocess.run(fzf_cmd, stdout=subprocess.PIPE, text=True, check=True, shell=True,).stdout
+        search_res_raw = subprocess.run(fzf_cmd, stdout=subprocess.PIPE, text=True, check=True, shell=True).stdout
         search_res = search_res_raw.strip().split("\\n")[:-1]
     except subprocess.CalledProcessError as cpe:
         console.print(Panel(f"❌ ERROR | FZF search failed with '{sub_string}' in '{search_root_obj}'.\n{cpe}", title="Error", expand=False))
         import sys
+
         sys.exit(f"💥 FILE NOT FOUND | Path {sub_string} does not exist @ root {search_root_obj}. No search results.")
-    if len(search_res) == 1: return search_root_obj.joinpath(search_res_raw)
+    if len(search_res) == 1:
+        return search_root_obj.joinpath(search_res_raw)
 
     print(f"⚠️ WARNING | Multiple search results found for `{sub_string}`\n'{search_res_raw}'")
     cmd = f"cd '{search_root_obj}'; fd --type file | fzf --select-1 --query={sub_string}"