notify-frame 0.1.2__tar.gz

notify_frame-0.1.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 elves / tango_util / python
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

notify_frame-0.1.2/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: notify-frame
+Version: 0.1.2
+Summary: Lightweight REST notification client/server for calculation scripts
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Provides-Extra: server
+Requires-Dist: fastapi>=0.100; extra == "server"
+Requires-Dist: pydantic>=2.0; extra == "server"
+Requires-Dist: uvicorn>=0.20; extra == "server"
+Provides-Extra: windows-outlook
+Requires-Dist: pywin32>=300; platform_system == "Windows" and extra == "windows-outlook"
+Dynamic: license-file

notify_frame-0.1.2/README.md

@@ -0,0 +1,206 @@
+# notify
+
+計算機から自分の PC 上の通知サーバーへ REST API で通知要求を送り、PC
+側からメールを送信する Python パッケージです。
+
+計算機側にはメールアカウント、SMTP
+パスワード、アプリパスワードを置きません。メール送信は PC
+側だけで行います。
+
+## v0.1.0
+
+v0.1.0 では、計算スクリプトから通知を簡単に呼び出せるように
+`configure()` を追加しました。また、サーバー設定を環境変数だけでなく
+`NotifyConfig` へ直接指定できるようにしました。
+
+### 計算機側
+
+最初に一度だけ通知サーバーを設定します。
+
+``` python
+from notify import configure, notify
+
+configure(
+    server_url="http://your-pc-hostname-or-ip:8000/notify",
+    token="shared-token",
+)
+
+notify("Calculation started")
+
+# calculation()
+
+notify(
+    "Calculation finished",
+    "Calculation completed successfully.",
+)
+```
+
+`configure()` で設定した値は、その後の `notify()`
+で既定値として使用されます。
+
+`notify()` は成功時に `True`、失敗時に `False`
+を返します。デフォルトでは、サーバー停止、通信不能、timeout、HTTP
+エラー、設定不足などが発生しても例外を計算側へ伝播しません。
+
+通知失敗を例外として扱う場合だけ `strict=True` を指定します。
+
+``` python
+notify("Calculation finished", strict=True)
+```
+
+`configure()` を使用せず、従来どおり `NOTIFY_SERVER_URL` と
+`NOTIFY_TOKEN` の環境変数を使用することもできます。
+
+### PC 側サーバー
+
+サーバー設定は `NotifyConfig` へ直接渡せます。
+
+``` python
+from notify.server import NotifyConfig, main
+
+config = NotifyConfig(
+    token="shared-token",
+    backend="mail_client",
+    mail_client="mail",
+    mail_to="your_account@example.com",
+)
+
+main(
+    config=config,
+    host="0.0.0.0",
+    port=8000,
+)
+```
+
+`NotifyConfig`
+に値を指定しなかった項目については、従来どおり環境変数が使用されます。
+
+`main()` の `host` / `port` を省略した場合も、`NOTIFY_HOST` /
+`NOTIFY_PORT` を参照し、未設定なら `127.0.0.1:8000` を使用します。
+
+## 通知方式
+
+### macOS Mail.app
+
+``` python
+config = NotifyConfig(
+    token="shared-token",
+    backend="mail_client",
+    mail_client="mail",
+    mail_to="your_account@example.com",
+)
+```
+
+AppleScript で macOS Mail.app を操作してメールを送信します。
+
+### Microsoft Outlook
+
+``` python
+config = NotifyConfig(
+    token="shared-token",
+    backend="mail_client",
+    mail_client="outlook",
+    mail_to="your_account@example.com",
+)
+```
+
+macOS では AppleScript、Windows では COM (`pywin32`) を使用して
+Microsoft Outlook を操作します。
+
+### SMTP
+
+``` python
+config = NotifyConfig(
+    token="shared-token",
+    backend="smtp",
+    mail_to="your_account@example.com",
+    smtp_host="smtp.example.com",
+    smtp_port=587,
+    smtp_user="your_account@example.com",
+    smtp_password="password-or-app-password",
+)
+```
+
+SMTP は STARTTLS と SMTP 認証を使用します。
+
+## Shell スクリプト
+
+Shell から使用する場合は、従来どおり `NOTIFY_SERVER_URL` と
+`NOTIFY_TOKEN` を環境変数で与えれば `python -c` から呼び出せます。
+
+``` bash
+if ./run_calc.sh; then
+    python -c 'from notify import notify; notify("OK", "Calculation finished successfully.")'
+else
+    status=$?
+    python -c 'from notify import notify; notify("FAILED", "Calculation failed.")'
+    exit "$status"
+fi
+```
+
+デフォルトでは通知失敗が計算コマンドの終了状態へ影響しません。
+
+## REST API
+
+REST API は従来と同じです。
+
+``` text
+POST /notify
+```
+
+JSON:
+
+``` json
+{
+  "title": "OK",
+  "body": "Calculation finished successfully."
+}
+```
+
+HTTP header:
+
+``` text
+X-Notify-Token: shared-token
+```
+
+## サーバー設定項目
+
+`NotifyConfig` で直接指定できる項目は次のとおりです。
+
+``` text
+token
+backend
+mail_client
+mail_to
+smtp_host
+smtp_port
+smtp_user
+smtp_password
+```
+
+対応する従来の環境変数も使用できます。
+
+``` text
+NOTIFY_TOKEN
+NOTIFY_BACKEND
+NOTIFY_MAIL_CLIENT
+MAIL_TO
+SMTP_HOST
+SMTP_PORT
+SMTP_USER
+SMTP_PASSWORD
+NOTIFY_HOST
+NOTIFY_PORT
+```
+
+直接指定した値は環境変数より優先されます。
+
+## セキュリティ
+
+計算機側に必要なのは通知サーバー URL
+と共有トークンだけです。メールアカウントや SMTP 認証情報は PC
+側に置きます。
+
+REST
+サーバーをインターネットへ直接公開することは前提としていません。外部ネットワークから利用する場合は、VPN、SSH
+トンネル、ファイアウォール、HTTPS 等を別途使用してください。

notify_frame-0.1.2/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "notify-frame"
+version = "0.1.2"
+
+description = "Lightweight REST notification client/server for calculation scripts"
+readme = "README.ja.md"
+requires-python = ">=3.8"
+dependencies = [
+    "requests>=2.20",
+]
+
+[project.optional-dependencies]
+server = [
+    "fastapi>=0.100",
+    "pydantic>=2.0",
+    "uvicorn>=0.20",
+]
+windows-outlook = [
+    "pywin32>=300; platform_system == 'Windows'",
+]
+
+[project.scripts]
+notify-server = "notify.server:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["notify*"]

notify_frame-0.1.2/setup.cfg

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

notify_frame-0.1.2/src/notify/__init__.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+from .client import NotifyClient, configure, notify
+
+__all__ = ["NotifyClient", "configure", "notify"]

notify_frame-0.1.2/src/notify/client.py

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+"""Client-side notification API for compute hosts."""
+
+import os
+from typing import Optional
+
+import requests
+
+DEFAULT_TIMEOUT = 10.0
+
+_default_server_url = ""
+_default_token = ""
+_default_timeout = DEFAULT_TIMEOUT
+
+
+def configure(
+    server_url: str,
+    token: str,
+    timeout: float = DEFAULT_TIMEOUT,
+) -> None:
+    """Set default client settings used by notify()."""
+    global _default_server_url
+    global _default_token
+    global _default_timeout
+
+    _default_server_url = server_url
+    _default_token = token
+    _default_timeout = timeout
+
+
+class NotifyClient(object):
+    """Small HTTP client used from calculation scripts."""
+
+    def __init__(
+        self,
+        server_url: Optional[str] = None,
+        token: Optional[str] = None,
+        timeout: Optional[float] = None,
+    ) -> None:
+        if server_url is None:
+            server_url = _default_server_url
+        if server_url == "":
+            server_url = os.environ.get("NOTIFY_SERVER_URL", "")
+
+        if token is None:
+            token = _default_token
+        if token == "":
+            token = os.environ.get("NOTIFY_TOKEN", "")
+
+        if timeout is None:
+            timeout = _default_timeout
+
+        self.server_url = server_url
+        self.token = token
+        self.timeout = timeout
+
+    def validate(self) -> None:
+        if self.server_url == "":
+            raise RuntimeError("NOTIFY_SERVER_URL is not set")
+        if self.token == "":
+            raise RuntimeError("NOTIFY_TOKEN is not set")
+
+    def send(self, title: str, body: str = "", strict: bool = False) -> bool:
+        """Send a notification. Failure is isolated unless strict=True."""
+        try:
+            self.validate()
+            response = requests.post(
+                self.server_url,
+                json={"title": title, "body": body},
+                headers={"X-Notify-Token": self.token},
+                timeout=self.timeout,
+            )
+            response.raise_for_status()
+            return True
+        except Exception:
+            if strict:
+                raise
+            return False
+
+
+def notify(
+    title: str,
+    body: str = "",
+    strict: bool = False,
+    server_url: Optional[str] = None,
+    token: Optional[str] = None,
+    timeout: Optional[float] = None,
+) -> bool:
+    """Send a notification with a one-call API."""
+    client = NotifyClient(
+        server_url=server_url,
+        token=token,
+        timeout=timeout,
+    )
+    return client.send(title=title, body=body, strict=strict)

notify_frame-0.1.2/src/notify/server.py

@@ -0,0 +1,229 @@
+# -*- coding: utf-8 -*-
+"""REST notification server intended to run on the user's PC."""
+
+import os
+import platform
+import smtplib
+import subprocess
+from email.mime.text import MIMEText
+from typing import Any, Dict, Optional
+
+import uvicorn
+from fastapi import FastAPI, Header, HTTPException
+from pydantic import BaseModel
+
+DEFAULT_HOST = "127.0.0.1"
+DEFAULT_PORT = 8000
+
+app = FastAPI(title="Notify Server")
+_server_config = None
+
+
+class NotifyMessage(BaseModel):
+    title: str
+    body: str = ""
+
+
+class NotifyConfig(object):
+    """Server settings. Direct values take priority over environment variables."""
+
+    def __init__(
+        self,
+        token: Optional[str] = None,
+        backend: Optional[str] = None,
+        mail_client: Optional[str] = None,
+        mail_to: Optional[str] = None,
+        smtp_host: Optional[str] = None,
+        smtp_port: Optional[int] = None,
+        smtp_user: Optional[str] = None,
+        smtp_password: Optional[str] = None,
+    ) -> None:
+        if token is None:
+            token = os.environ.get("NOTIFY_TOKEN", "")
+        if backend is None:
+            backend = os.environ.get("NOTIFY_BACKEND", "mail_client")
+        if mail_client is None:
+            mail_client = os.environ.get("NOTIFY_MAIL_CLIENT", "mail")
+        if mail_to is None:
+            mail_to = os.environ.get("MAIL_TO", "")
+        if smtp_host is None:
+            smtp_host = os.environ.get("SMTP_HOST", "")
+        if smtp_port is None:
+            smtp_port = int(os.environ.get("SMTP_PORT", "587"))
+        if smtp_user is None:
+            smtp_user = os.environ.get("SMTP_USER", "")
+        if smtp_password is None:
+            smtp_password = os.environ.get("SMTP_PASSWORD", "")
+
+        self.token = token
+        self.backend = backend
+        self.mail_client = mail_client
+        self.mail_to = mail_to
+        self.smtp_host = smtp_host
+        self.smtp_port = smtp_port
+        self.smtp_user = smtp_user
+        self.smtp_password = smtp_password
+
+    def validate_common(self) -> None:
+        if self.token == "":
+            raise RuntimeError("NOTIFY_TOKEN is not set")
+        if self.mail_to == "":
+            raise RuntimeError("MAIL_TO is not set")
+
+    def validate_mail_client(self) -> None:
+        if self.mail_client not in ("mail", "outlook"):
+            raise RuntimeError("Unknown NOTIFY_MAIL_CLIENT: %s" % self.mail_client)
+        system = platform.system()
+        if self.mail_client == "mail" and system != "Darwin":
+            raise RuntimeError("Mail.app backend is available only on macOS")
+        if self.mail_client == "outlook" and system not in ("Darwin", "Windows"):
+            raise RuntimeError("Outlook backend is available on macOS or Windows")
+
+    def validate_smtp(self) -> None:
+        if self.smtp_host == "":
+            raise RuntimeError("SMTP_HOST is not set")
+        if self.smtp_user == "":
+            raise RuntimeError("SMTP_USER is not set")
+        if self.smtp_password == "":
+            raise RuntimeError("SMTP_PASSWORD is not set")
+
+
+def get_config() -> NotifyConfig:
+    if _server_config is not None:
+        return _server_config
+    return NotifyConfig()
+
+
+def escape_applescript_text(text: str) -> str:
+    escaped = text.replace("\\", "\\\\")
+    escaped = escaped.replace('"', '\\"')
+    return escaped
+
+
+def send_by_mail_app(config: NotifyConfig, title: str, body: str) -> None:
+    subject = escape_applescript_text(title)
+    content = escape_applescript_text(body)
+    recipient = escape_applescript_text(config.mail_to)
+    script = '''
+tell application "Mail"
+    set newMessage to make new outgoing message with properties {subject:"%s", content:"%s", visible:false}
+    tell newMessage
+        make new to recipient at end of to recipients with properties {address:"%s"}
+        send
+    end tell
+end tell
+''' % (subject, content, recipient)
+    subprocess.check_call(["osascript", "-e", script])
+
+
+def send_by_outlook_mac(config: NotifyConfig, title: str, body: str) -> None:
+    subject = escape_applescript_text(title)
+    content = escape_applescript_text(body)
+    recipient = escape_applescript_text(config.mail_to)
+    script = '''
+tell application "Microsoft Outlook"
+    set newMessage to make new outgoing message with properties {subject:"%s", content:"%s"}
+    make new recipient at newMessage with properties {email address:{address:"%s"}}
+    send newMessage
+end tell
+''' % (subject, content, recipient)
+    subprocess.check_call(["osascript", "-e", script])
+
+
+def send_by_outlook_windows(config: NotifyConfig, title: str, body: str) -> None:
+    try:
+        import win32com.client  # type: ignore
+    except ImportError:
+        raise RuntimeError("Windows Outlook backend requires pywin32")
+
+    outlook = win32com.client.Dispatch("Outlook.Application")
+    message = outlook.CreateItem(0)
+    message.To = config.mail_to
+    message.Subject = title
+    message.Body = body
+    message.Send()
+
+
+def send_by_outlook_app(config: NotifyConfig, title: str, body: str) -> None:
+    system = platform.system()
+    if system == "Darwin":
+        send_by_outlook_mac(config, title, body)
+        return
+    if system == "Windows":
+        send_by_outlook_windows(config, title, body)
+        return
+    raise RuntimeError("Outlook backend is available on macOS or Windows")
+
+
+def send_by_mail_client(config: NotifyConfig, title: str, body: str) -> None:
+    config.validate_mail_client()
+    if config.mail_client == "mail":
+        send_by_mail_app(config, title, body)
+        return
+    if config.mail_client == "outlook":
+        send_by_outlook_app(config, title, body)
+        return
+    raise RuntimeError("Unknown NOTIFY_MAIL_CLIENT: %s" % config.mail_client)
+
+
+def send_by_smtp(config: NotifyConfig, title: str, body: str) -> None:
+    config.validate_smtp()
+    message = MIMEText(body, "plain", "utf-8")
+    message["Subject"] = title
+    message["From"] = config.smtp_user
+    message["To"] = config.mail_to
+    with smtplib.SMTP(config.smtp_host, config.smtp_port) as smtp:
+        smtp.starttls()
+        smtp.login(config.smtp_user, config.smtp_password)
+        smtp.send_message(message)
+
+
+def send_notification(config: NotifyConfig, title: str, body: str) -> None:
+    config.validate_common()
+    if config.backend == "mail_client":
+        send_by_mail_client(config, title, body)
+        return
+    if config.backend == "smtp":
+        send_by_smtp(config, title, body)
+        return
+    raise RuntimeError("Unknown NOTIFY_BACKEND: %s" % config.backend)
+
+
+@app.post("/notify")
+def receive_notify(
+    message: NotifyMessage,
+    x_notify_token: str = Header(default=""),
+) -> Dict[str, Any]:
+    config = get_config()
+    if x_notify_token != config.token:
+        raise HTTPException(status_code=403, detail="Forbidden")
+    try:
+        send_notification(config, message.title, message.body)
+    except Exception as exc:
+        raise HTTPException(status_code=500, detail=str(exc))
+    return {
+        "ok": True,
+        "backend": config.backend,
+        "mail_client": config.mail_client,
+    }
+
+
+def main(
+    config: Optional[NotifyConfig] = None,
+    host: Optional[str] = None,
+    port: Optional[int] = None,
+) -> None:
+    global _server_config
+
+    _server_config = config
+
+    if host is None:
+        host = os.environ.get("NOTIFY_HOST", DEFAULT_HOST)
+    if port is None:
+        port = int(os.environ.get("NOTIFY_PORT", str(DEFAULT_PORT)))
+
+    uvicorn.run(app, host=host, port=port)
+
+
+if __name__ == "__main__":
+    main()

notify_frame-0.1.2/src/notify_frame.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: notify-frame
+Version: 0.1.2
+Summary: Lightweight REST notification client/server for calculation scripts
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Provides-Extra: server
+Requires-Dist: fastapi>=0.100; extra == "server"
+Requires-Dist: pydantic>=2.0; extra == "server"
+Requires-Dist: uvicorn>=0.20; extra == "server"
+Provides-Extra: windows-outlook
+Requires-Dist: pywin32>=300; platform_system == "Windows" and extra == "windows-outlook"
+Dynamic: license-file

notify_frame-0.1.2/src/notify_frame.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/notify/__init__.py
+src/notify/client.py
+src/notify/server.py
+src/notify_frame.egg-info/PKG-INFO
+src/notify_frame.egg-info/SOURCES.txt
+src/notify_frame.egg-info/dependency_links.txt
+src/notify_frame.egg-info/entry_points.txt
+src/notify_frame.egg-info/requires.txt
+src/notify_frame.egg-info/top_level.txt

notify_frame-0.1.2/src/notify_frame.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

notify_frame-0.1.2/src/notify_frame.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+notify-server = notify.server:main

notify_frame-0.1.2/src/notify_frame.egg-info/requires.txt

@@ -0,0 +1,11 @@
+requests>=2.20
+
+[server]
+fastapi>=0.100
+pydantic>=2.0
+uvicorn>=0.20
+
+[windows-outlook]
+
+[windows-outlook:platform_system == "Windows"]
+pywin32>=300

notify_frame-0.1.2/src/notify_frame.egg-info/top_level.txt

@@ -0,0 +1 @@
+notify