train-notifier 1.0.0__tar.gz

train_notifier-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 hjz
+
+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.

train_notifier-1.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: train-notifier
+Version: 1.0.0
+Summary: 训练任务邮件通知工具，支持模板和系统信息自动附带
+Author-email: hjz <1912285210@qq.com>
+License: MIT
+Project-URL: Homepage, https://github.com/hjz/train-notifier
+Keywords: notifier,email,training,machine-learning
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: apprise>=1.0.0
+Requires-Dist: python-dotenv>=0.19.0
+Dynamic: license-file
+
+# train-notifier
+
+训练任务邮件通知工具，支持模板和系统信息自动附带。
+
+## 安装
+
+```bash
+pip install train-notifier
+```
+
+## 快速使用
+
+### 1. 创建 `.env` 文件
+
+```env
+SMTP_SERVER=smtp.qq.com
+SMTP_PORT=465
+SMTP_USER=你的邮箱@qq.com
+SMTP_PASS=你的授权码
+RECV_EMAIL=收件邮箱@qq.com
+```
+
+### 2. 代码调用
+
+```python
+from notifier import Notifier
+
+n = Notifier()
+
+# 自定义通知
+n.notify(title="标题", body="内容")
+
+# 训练完成（无参数）
+n.train_done()
+
+# 训练出错
+n.train_error(message="CUDA out of memory")
+
+# Epoch 进度
+n.epoch_done(epoch=3, total=10, loss=0.0234)
+
+# 任务完成
+n.task_done(task_name="数据预处理")
+
+# 自定义提醒
+n.alert(message="GPU 温度过高！")
+```
+
+## 函数列表
+
+| 函数 | 参数 | 说明 |
+|------|------|------|
+| `notify(title, body)` | 标题, 内容 | 自定义通知 |
+| `train_done()` | 无 | 训练完成 |
+| `train_error(message)` | 错误信息 | 训练出错 |
+| `epoch_done(epoch, total, loss)` | 轮数, 总轮数, 损失值 | Epoch 完成 |
+| `task_done(task_name)` | 任务名称 | 任务完成 |
+| `alert(message)` | 提醒内容 | 自定义提醒 |
+
+## 邮件样式
+
+每封邮件包含：
+- 紫色渐变头部
+- 称呼：尊敬的训练师
+- 内容区（左侧色条高亮）
+- 系统信息（时间、主机、系统、Python 版本）
+
+## 许可证
+
+MIT

train_notifier-1.0.0/README.md

@@ -0,0 +1,70 @@
+# train-notifier
+
+训练任务邮件通知工具，支持模板和系统信息自动附带。
+
+## 安装
+
+```bash
+pip install train-notifier
+```
+
+## 快速使用
+
+### 1. 创建 `.env` 文件
+
+```env
+SMTP_SERVER=smtp.qq.com
+SMTP_PORT=465
+SMTP_USER=你的邮箱@qq.com
+SMTP_PASS=你的授权码
+RECV_EMAIL=收件邮箱@qq.com
+```
+
+### 2. 代码调用
+
+```python
+from notifier import Notifier
+
+n = Notifier()
+
+# 自定义通知
+n.notify(title="标题", body="内容")
+
+# 训练完成（无参数）
+n.train_done()
+
+# 训练出错
+n.train_error(message="CUDA out of memory")
+
+# Epoch 进度
+n.epoch_done(epoch=3, total=10, loss=0.0234)
+
+# 任务完成
+n.task_done(task_name="数据预处理")
+
+# 自定义提醒
+n.alert(message="GPU 温度过高！")
+```
+
+## 函数列表
+
+| 函数 | 参数 | 说明 |
+|------|------|------|
+| `notify(title, body)` | 标题, 内容 | 自定义通知 |
+| `train_done()` | 无 | 训练完成 |
+| `train_error(message)` | 错误信息 | 训练出错 |
+| `epoch_done(epoch, total, loss)` | 轮数, 总轮数, 损失值 | Epoch 完成 |
+| `task_done(task_name)` | 任务名称 | 任务完成 |
+| `alert(message)` | 提醒内容 | 自定义提醒 |
+
+## 邮件样式
+
+每封邮件包含：
+- 紫色渐变头部
+- 称呼：尊敬的训练师
+- 内容区（左侧色条高亮）
+- 系统信息（时间、主机、系统、Python 版本）
+
+## 许可证
+
+MIT

train_notifier-1.0.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "train-notifier"
+version = "1.0.0"
+description = "训练任务邮件通知工具，支持模板和系统信息自动附带"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    {name = "hjz", email = "1912285210@qq.com"}
+]
+keywords = ["notifier", "email", "training", "machine-learning"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "apprise>=1.0.0",
+    "python-dotenv>=0.19.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/hjz/train-notifier"

train_notifier-1.0.0/setup.cfg

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

train_notifier-1.0.0/src/notifier/__init__.py

@@ -0,0 +1,4 @@
+from .notifier import Notifier
+
+__all__ = ["Notifier"]
+__version__ = "1.0.0"

train_notifier-1.0.0/src/notifier/notifier.py

@@ -0,0 +1,217 @@
+"""
+train-notifier - 训练任务邮件通知工具
+
+使用方法:
+    from notifier import Notifier
+
+    n = Notifier()
+
+    # 自定义通知
+    n.notify(title="标题", body="内容")
+
+    # 训练完成（无参数）
+    n.train_done()
+
+    # 训练出错
+    n.train_error(message="CUDA out of memory")
+
+    # Epoch 进度
+    n.epoch_done(epoch=3, total=10, loss=0.0234)
+
+    # 任务完成
+    n.task_done(task_name="数据预处理")
+
+    # 自定义提醒
+    n.alert(message="GPU 温度过高！")
+
+函数列表:
+    notify(title, body)                     自定义通知
+    train_done()                            训练完成（无参数）
+    train_error(message="未知错误")          训练出错
+    epoch_done(epoch, total, loss)          Epoch 完成
+    task_done(task_name)                    任务完成
+    alert(message)                          自定义提醒
+
+.env 配置:
+    SMTP_SERVER=smtp.qq.com                 SMTP 服务器地址
+    SMTP_PORT=465                           端口号
+    SMTP_USER=你的邮箱@qq.com               发件邮箱
+    SMTP_PASS=你的授权码                    邮箱授权码（非登录密码）
+    RECV_EMAIL=收件邮箱@qq.com              收件邮箱
+"""
+
+import apprise
+from dotenv import load_dotenv
+import os
+import platform
+from datetime import datetime
+
+load_dotenv()
+
+
+class Notifier:
+    """邮件通知工具类
+
+    每封邮件自动附带: 称呼、时间、主机名、系统版本、Python 版本
+
+    函数列表:
+        notify(title, body)                     自定义通知
+        train_done()                            训练完成（无参数）
+        train_error(message="未知错误")          训练出错
+        epoch_done(epoch, total, loss)          Epoch 完成
+        task_done(task_name)                    任务完成
+        alert(message)                          自定义提醒
+    """
+
+    REQUIRED = ["SMTP_SERVER", "SMTP_PORT", "SMTP_USER", "SMTP_PASS", "RECV_EMAIL"]
+
+    def __init__(self):
+        """初始化，从 .env 加载配置，缺失时抛出异常"""
+        self.smtp_server = os.getenv("SMTP_SERVER")
+        self.smtp_port = os.getenv("SMTP_PORT")
+        self.smtp_user = os.getenv("SMTP_USER")
+        self.smtp_pass = os.getenv("SMTP_PASS")
+        self.recv_email = os.getenv("RECV_EMAIL")
+
+        # 检查缺失或为空的配置
+        missing = [k for k in self.REQUIRED if not os.getenv(k)]
+        if missing:
+            example = (
+                "\n请在 .env 文件中补全以下配置：\n"
+                "SMTP_SERVER=smtp.qq.com\n"
+                "SMTP_PORT=465\n"
+                "SMTP_USER=你的邮箱@qq.com\n"
+                "SMTP_PASS=你的授权码\n"
+                "RECV_EMAIL=收件邮箱@qq.com"
+            )
+            raise ValueError(f".env 缺少以下配置: {missing}{example}")
+
+    def _build_html(self, body: str) -> str:
+        """构建 HTML 邮件内容"""
+        now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+        return f"""
+        <div style="font-family: 'Microsoft YaHei', Arial, sans-serif; max-width: 600px; margin: 0 auto; padding: 20px; background: #f5f5f5;">
+            <div style="background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); padding: 20px; border-radius: 10px 10px 0 0; text-align: center;">
+                <h2 style="color: white; margin: 0;">📬 训练通知</h2>
+            </div>
+
+            <div style="background: white; padding: 25px; border-radius: 0 0 10px 10px; box-shadow: 0 2px 10px rgba(0,0,0,0.1);">
+                <p style="font-size: 16px; color: #333;">尊敬的训练师，</p>
+
+                <div style="background: #f8f9fa; padding: 15px; border-left: 4px solid #667eea; margin: 15px 0; border-radius: 0 5px 5px 0;">
+                    <p style="margin: 0; color: #555; font-size: 15px;">{body}</p>
+                </div>
+
+                <hr style="border: none; border-top: 1px dashed #ddd; margin: 20px 0;">
+
+                <div style="font-size: 13px; color: #888; line-height: 1.8;">
+                    <p style="margin: 5px 0;">⏰ <b>时间：</b>{now}</p>
+                    <p style="margin: 5px 0;">💻 <b>主机：</b>{platform.node()}</p>
+                    <p style="margin: 5px 0;">🖥️ <b>系统：</b>{platform.system()} {platform.release()}</p>
+                    <p style="margin: 5px 0;">🐍 <b>Python：</b>{platform.python_version()}</p>
+                </div>
+            </div>
+
+            <p style="text-align: center; font-size: 12px; color: #aaa; margin-top: 15px;">
+                此邮件由 train-notifier 自动发送
+            </p>
+        </div>
+        """
+
+    def _send(self, title: str, body: str) -> bool:
+        """内部发送方法"""
+        html = self._build_html(body)
+
+        ap = apprise.Apprise()
+        ap.add(f"mailtos://{self.recv_email}:{self.smtp_port}?smtp={self.smtp_server}&user={self.smtp_user}&pass={self.smtp_pass}&mode=ssl")
+
+        result = ap.notify(title=title, body=html)
+
+        if not result:
+            print("❌ 邮件发送失败，请检查 .env 配置")
+
+        return result
+
+    def notify(self, title: str, body: str) -> bool:
+        """自定义通知
+
+        Args:
+            title: 邮件标题
+            body:  邮件内容
+
+        Returns:
+            bool: True=成功, False=失败
+
+        Example:
+            n.notify("自定义标题", "随便写点内容")
+        """
+        return self._send(title, body)
+
+    def train_done(self) -> bool:
+        """训练完成通知（无参数）
+
+        Returns:
+            bool: True=成功, False=失败
+
+        Example:
+            n.train_done()
+        """
+        return self._send("🎉 训练完成", "✅ 模型训练已全部结束，请查看结果。")
+
+    def train_error(self, message: str = "未知错误") -> bool:
+        """训练出错通知
+
+        Args:
+            message: 错误信息，默认 "未知错误"
+
+        Returns:
+            bool: True=成功, False=失败
+
+        Example:
+            n.train_error("CUDA out of memory")
+        """
+        return self._send("❌ 训练出错", f"⚠️ 训练过程中发生错误：{message}")
+
+    def epoch_done(self, epoch: int, total: int, loss: float) -> bool:
+        """Epoch 完成通知
+
+        Args:
+            epoch: 当前轮数
+            total: 总轮数
+            loss:  当前损失值
+
+        Returns:
+            bool: True=成功, False=失败
+
+        Example:
+            n.epoch_done(epoch=3, total=10, loss=0.0234)
+        """
+        return self._send("📊 Epoch 完成", f"Epoch {epoch}/{total} 已完成，当前 loss: {loss}")
+
+    def task_done(self, task_name: str) -> bool:
+        """任务完成通知
+
+        Args:
+            task_name: 任务名称
+
+        Returns:
+            bool: True=成功, False=失败
+
+        Example:
+            n.task_done("数据预处理")
+        """
+        return self._send("✅ 任务完成", f"任务 \"{task_name}\" 已执行完毕。")
+
+    def alert(self, message: str) -> bool:
+        """自定义提醒
+
+        Args:
+            message: 提醒内容
+
+        Returns:
+            bool: True=成功, False=失败
+
+        Example:
+            n.alert("GPU 温度过高！")
+        """
+        return self._send("🔔 提醒", message)

train_notifier-1.0.0/src/train_notifier.egg-info/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: train-notifier
+Version: 1.0.0
+Summary: 训练任务邮件通知工具，支持模板和系统信息自动附带
+Author-email: hjz <1912285210@qq.com>
+License: MIT
+Project-URL: Homepage, https://github.com/hjz/train-notifier
+Keywords: notifier,email,training,machine-learning
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: apprise>=1.0.0
+Requires-Dist: python-dotenv>=0.19.0
+Dynamic: license-file
+
+# train-notifier
+
+训练任务邮件通知工具，支持模板和系统信息自动附带。
+
+## 安装
+
+```bash
+pip install train-notifier
+```
+
+## 快速使用
+
+### 1. 创建 `.env` 文件
+
+```env
+SMTP_SERVER=smtp.qq.com
+SMTP_PORT=465
+SMTP_USER=你的邮箱@qq.com
+SMTP_PASS=你的授权码
+RECV_EMAIL=收件邮箱@qq.com
+```
+
+### 2. 代码调用
+
+```python
+from notifier import Notifier
+
+n = Notifier()
+
+# 自定义通知
+n.notify(title="标题", body="内容")
+
+# 训练完成（无参数）
+n.train_done()
+
+# 训练出错
+n.train_error(message="CUDA out of memory")
+
+# Epoch 进度
+n.epoch_done(epoch=3, total=10, loss=0.0234)
+
+# 任务完成
+n.task_done(task_name="数据预处理")
+
+# 自定义提醒
+n.alert(message="GPU 温度过高！")
+```
+
+## 函数列表
+
+| 函数 | 参数 | 说明 |
+|------|------|------|
+| `notify(title, body)` | 标题, 内容 | 自定义通知 |
+| `train_done()` | 无 | 训练完成 |
+| `train_error(message)` | 错误信息 | 训练出错 |
+| `epoch_done(epoch, total, loss)` | 轮数, 总轮数, 损失值 | Epoch 完成 |
+| `task_done(task_name)` | 任务名称 | 任务完成 |
+| `alert(message)` | 提醒内容 | 自定义提醒 |
+
+## 邮件样式
+
+每封邮件包含：
+- 紫色渐变头部
+- 称呼：尊敬的训练师
+- 内容区（左侧色条高亮）
+- 系统信息（时间、主机、系统、Python 版本）
+
+## 许可证
+
+MIT

train_notifier-1.0.0/src/train_notifier.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/notifier/__init__.py
+src/notifier/notifier.py
+src/train_notifier.egg-info/PKG-INFO
+src/train_notifier.egg-info/SOURCES.txt
+src/train_notifier.egg-info/dependency_links.txt
+src/train_notifier.egg-info/requires.txt
+src/train_notifier.egg-info/top_level.txt

train_notifier-1.0.0/src/train_notifier.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

train_notifier-1.0.0/src/train_notifier.egg-info/requires.txt

@@ -0,0 +1,2 @@
+apprise>=1.0.0
+python-dotenv>=0.19.0

train_notifier-1.0.0/src/train_notifier.egg-info/top_level.txt

@@ -0,0 +1 @@
+notifier