slurm-mailer 0.1.0__tar.gz

slurm_mailer-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hu Zheyang <jsjyhzy@gmail.com>
+
+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.

slurm_mailer-0.1.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: slurm-mailer
+Version: 0.1.0
+Summary: Slurm job status transient notification program via email
+Author-email: Hu Zheyang <jsjyhzy@gmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# slurm-mailer
+
+Slurm Job Status Notification Daemon
+
+A tool for monitoring Slurm job status changes and sending email notifications
+when jobs transition between states. Changes are aggregated over a configurable
+time window before sending.
+
+---
+
+## ⚠️ Important Notice
+
+**This project is AI-generated.** The code has not been thoroughly reviewed by a
+human developer for all edge cases, security implications, or production-readiness.
+Use at your own risk.
+
+---
+
+## User-Space Notification
+
+This tool operates entirely on the Slurm client side. **No Slurm administrator
+privileges or configuration changes are required.**
+
+- Runs by polling `squeue` and `sacct` like any Slurm user can do
+- No modifications to `slurm.conf`, `sacct.conf`, or admin partitions required
+- Can monitor only your own jobs, or all visible jobs if permissions allow
+- No system-wide impact; runs as a regular daemon
+
+### How It Differs from Admin Notifications
+
+| Admin System Notification | This Tool |
+|---|---|
+| Requires `slurm.conf` modifications | Runs as standalone daemon |
+| Admin sets recipients | User configures their own email |
+| Affects all users | Only monitors specified user's jobs |
+| Requires restart of daemons | Runs independently |
+| Site-wide policy | User-controlled |
+
+---
+
+## Features
+
+- **Dual querying**: Uses both `squeue` (active jobs) and `sacct` (completed/failed jobs)
+- **Change detection** with aggregation window
+- **Rich HTML email** with inline CSS (emoji-free)
+- **Configurable polling interval** and aggregation window
+- **Aggregation** of multiple changes before sending
+- **Status badge** colors and labels
+
+### User-Space Benefits
+
+- No Slurm admin required
+- No system configuration changes
+- Works on shared/HPC systems where users cannot modify config
+- User controls who receives notifications
+- Can monitor any user within permission limits
+
+---
+
+## Installation
+
+```bash
+uv sync
+# or install the wheel
+uv pip install dist/slurm_mailer-0.1.0-py3-none-any.whl
+```
+
+## Configuration
+
+Copy `config.ini` and adjust the settings:
+
+```ini
+[smtp]
+host = smtp.example.com
+port = 587
+tls = true
+user = your_user
+password = your_password
+
+[email]
+from = slurm-mailer@example.com
+to = recipient@example.com
+
+[slurm]
+watch_all_users = false
+aggregation_minutes = 10
+poll_interval_seconds = 30
+```
+
+## Usage
+
+```bash
+slurm-mailer
+```
+
+Or run from source:
+
+```bash
+uv run slurm-mailer
+```
+
+## License
+
+MIT

slurm_mailer-0.1.0/README.md

@@ -0,0 +1,104 @@
+# slurm-mailer
+
+Slurm Job Status Notification Daemon
+
+A tool for monitoring Slurm job status changes and sending email notifications
+when jobs transition between states. Changes are aggregated over a configurable
+time window before sending.
+
+---
+
+## ⚠️ Important Notice
+
+**This project is AI-generated.** The code has not been thoroughly reviewed by a
+human developer for all edge cases, security implications, or production-readiness.
+Use at your own risk.
+
+---
+
+## User-Space Notification
+
+This tool operates entirely on the Slurm client side. **No Slurm administrator
+privileges or configuration changes are required.**
+
+- Runs by polling `squeue` and `sacct` like any Slurm user can do
+- No modifications to `slurm.conf`, `sacct.conf`, or admin partitions required
+- Can monitor only your own jobs, or all visible jobs if permissions allow
+- No system-wide impact; runs as a regular daemon
+
+### How It Differs from Admin Notifications
+
+| Admin System Notification | This Tool |
+|---|---|
+| Requires `slurm.conf` modifications | Runs as standalone daemon |
+| Admin sets recipients | User configures their own email |
+| Affects all users | Only monitors specified user's jobs |
+| Requires restart of daemons | Runs independently |
+| Site-wide policy | User-controlled |
+
+---
+
+## Features
+
+- **Dual querying**: Uses both `squeue` (active jobs) and `sacct` (completed/failed jobs)
+- **Change detection** with aggregation window
+- **Rich HTML email** with inline CSS (emoji-free)
+- **Configurable polling interval** and aggregation window
+- **Aggregation** of multiple changes before sending
+- **Status badge** colors and labels
+
+### User-Space Benefits
+
+- No Slurm admin required
+- No system configuration changes
+- Works on shared/HPC systems where users cannot modify config
+- User controls who receives notifications
+- Can monitor any user within permission limits
+
+---
+
+## Installation
+
+```bash
+uv sync
+# or install the wheel
+uv pip install dist/slurm_mailer-0.1.0-py3-none-any.whl
+```
+
+## Configuration
+
+Copy `config.ini` and adjust the settings:
+
+```ini
+[smtp]
+host = smtp.example.com
+port = 587
+tls = true
+user = your_user
+password = your_password
+
+[email]
+from = slurm-mailer@example.com
+to = recipient@example.com
+
+[slurm]
+watch_all_users = false
+aggregation_minutes = 10
+poll_interval_seconds = 30
+```
+
+## Usage
+
+```bash
+slurm-mailer
+```
+
+Or run from source:
+
+```bash
+uv run slurm-mailer
+```
+
+## License
+
+MIT

slurm_mailer-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "slurm-mailer"
+version = "0.1.0"
+description = "Slurm job status transient notification program via email"
+readme = "README.md"
+authors = [
+    { name = "Hu Zheyang", email = "jsjyhzy@gmail.com" }
+]
+requires-python = ">=3.9"
+license = { text = "MIT" }
+dependencies = []
+
+[project.scripts]
+slurm-mailer = "slurm_mailer:main"
+
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[dependency-groups]
+dev = [
+    "flake8>=7.3.0",
+]
+
+

slurm_mailer-0.1.0/setup.cfg

@@ -0,0 +1,8 @@
+[flake8]
+max-line-length = 350
+extend-ignore = E203, W503
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

slurm_mailer-0.1.0/src/slurm_mailer.egg-info/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: slurm-mailer
+Version: 0.1.0
+Summary: Slurm job status transient notification program via email
+Author-email: Hu Zheyang <jsjyhzy@gmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# slurm-mailer
+
+Slurm Job Status Notification Daemon
+
+A tool for monitoring Slurm job status changes and sending email notifications
+when jobs transition between states. Changes are aggregated over a configurable
+time window before sending.
+
+---
+
+## ⚠️ Important Notice
+
+**This project is AI-generated.** The code has not been thoroughly reviewed by a
+human developer for all edge cases, security implications, or production-readiness.
+Use at your own risk.
+
+---
+
+## User-Space Notification
+
+This tool operates entirely on the Slurm client side. **No Slurm administrator
+privileges or configuration changes are required.**
+
+- Runs by polling `squeue` and `sacct` like any Slurm user can do
+- No modifications to `slurm.conf`, `sacct.conf`, or admin partitions required
+- Can monitor only your own jobs, or all visible jobs if permissions allow
+- No system-wide impact; runs as a regular daemon
+
+### How It Differs from Admin Notifications
+
+| Admin System Notification | This Tool |
+|---|---|
+| Requires `slurm.conf` modifications | Runs as standalone daemon |
+| Admin sets recipients | User configures their own email |
+| Affects all users | Only monitors specified user's jobs |
+| Requires restart of daemons | Runs independently |
+| Site-wide policy | User-controlled |
+
+---
+
+## Features
+
+- **Dual querying**: Uses both `squeue` (active jobs) and `sacct` (completed/failed jobs)
+- **Change detection** with aggregation window
+- **Rich HTML email** with inline CSS (emoji-free)
+- **Configurable polling interval** and aggregation window
+- **Aggregation** of multiple changes before sending
+- **Status badge** colors and labels
+
+### User-Space Benefits
+
+- No Slurm admin required
+- No system configuration changes
+- Works on shared/HPC systems where users cannot modify config
+- User controls who receives notifications
+- Can monitor any user within permission limits
+
+---
+
+## Installation
+
+```bash
+uv sync
+# or install the wheel
+uv pip install dist/slurm_mailer-0.1.0-py3-none-any.whl
+```
+
+## Configuration
+
+Copy `config.ini` and adjust the settings:
+
+```ini
+[smtp]
+host = smtp.example.com
+port = 587
+tls = true
+user = your_user
+password = your_password
+
+[email]
+from = slurm-mailer@example.com
+to = recipient@example.com
+
+[slurm]
+watch_all_users = false
+aggregation_minutes = 10
+poll_interval_seconds = 30
+```
+
+## Usage
+
+```bash
+slurm-mailer
+```
+
+Or run from source:
+
+```bash
+uv run slurm-mailer
+```
+
+## License
+
+MIT

slurm_mailer-0.1.0/src/slurm_mailer.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+src/slurm_mailer.py
+src/slurm_mailer.egg-info/PKG-INFO
+src/slurm_mailer.egg-info/SOURCES.txt
+src/slurm_mailer.egg-info/dependency_links.txt
+src/slurm_mailer.egg-info/entry_points.txt
+src/slurm_mailer.egg-info/top_level.txt
+tests/test_slurm_mailer.py

slurm_mailer-0.1.0/src/slurm_mailer.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

slurm_mailer-0.1.0/src/slurm_mailer.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+slurm-mailer = slurm_mailer:main

slurm_mailer-0.1.0/src/slurm_mailer.egg-info/top_level.txt

@@ -0,0 +1 @@
+slurm_mailer