script-reporter 0.1.0__tar.gz

script_reporter-0.1.0/LICENSE

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

script_reporter-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: script-reporter
+Version: 0.1.0
+Summary: A lightweight status reporter for Python scripts with Discord and Telegram support
+Author-email: Yoonbae Cho <y@xcv.kr>
+License: MIT
+Project-URL: Homepage, https://github.com/yoonbae81/script-reporter
+Project-URL: Bug Tracker, https://github.com/yoonbae81/script-reporter/issues
+Keywords: reporter,notification,discord,telegram,script,monitoring
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# script-reporter 🚀
+
+A lightweight, zero-dependency Python status reporter designed for automation scripts and cron jobs. Easily report execution progress, stages, and results to **Console**, **Discord**, and **Telegram**.
+
+## ✨ Key Features
+
+- **Zero External Dependencies**: Uses Python standard library only (`urllib`).
+- **Multi-Channel**: Simultaneous reporting to Console, Discord (Webhooks), and Telegram (Bot API).
+- **Stage Tracking**: Monitor exactly where your script is (e.g., `SETUP` -> `PROCESSING` -> `COMPLETE`).
+- **Error Transparency**: Automatically attaches tracebacks on failure.
+- **Duration Tracking**: Automatically calculates and reports execution time.
+- **CI/CD & Cron Friendly**: Standardized JSON output for logs makes it easy for other tools to parse.
+
+## 📦 Installation
+
+```bash
+pip install script-reporter
+```
+
+## 🚀 Quick Start
+
+### 1. Simple Usage (Auto-reporitng)
+
+Set simple environment variables to enable channels:
+- `REPORTER_DISCORD_WEBHOOK`: Discord Webhook URL
+- `REPORTER_TELEGRAM_TOKEN` & `REPORTER_TELEGRAM_CHAT_ID`: Telegram Bot Token and Chat ID
+
+```python
+from script_reporter import ScriptReporter
+import traceback
+
+# Initialize with a title (auto-detects Discord/Telegram from Env)
+reporter = ScriptReporter("My Automation Task")
+
+try:
+    # 1. Start a stage
+    reporter.stage("DATA_FETCH")
+    # ... your logic ...
+    
+    # 2. Update stage as you progress
+    reporter.stage("PROCESSING")
+    # ... your logic ...
+    
+    # 3. Report success with optional detail dictionary
+    reporter.success({"items_processed": 100, "status": "all_good"})
+
+except Exception:
+    # 4. Report failure with traceback
+    reporter.fail(traceback.format_exc())
+```
+
+### 2. Manual Configuration
+
+Explicitly control adapters without environment variables:
+
+```python
+from script_reporter import ScriptReporter, ConsoleAdapter, DiscordAdapter, TelegramAdapter
+
+adapters = [
+    ConsoleAdapter(),
+    DiscordAdapter(webhook_url="https://discord.com/api/webhooks/..."),
+    TelegramAdapter(token="BOT_TOKEN", chat_id="CHAT_ID")
+]
+
+reporter = ScriptReporter("Manual Config Task", adapters=adapters)
+reporter.success({"msg": "Hello from code!"})
+```
+
+## 📊 JSON Log Format
+
+`ConsoleAdapter` prints a machine-readable JSON line starting with `__RESULT__`:
+
+```json
+__RESULT__ {"title": "My Task", "host": "server-01", "stage": "COMPLETE", "status": "SUCCESS", "duration": "1m 30s", "detail": {"processed": 5}}
+```
+
+## 🛠 Advanced Concepts
+
+- **Stages**: Use `reporter.stage("NAME")` to track progress. If `reporter.fail()` is called, it identifies the last successful stage.
+- **Duration**: Tracks time from `ScriptReporter()` initialization to `success()`/`fail()` call.
+- **Discord Rich Embeds**: `DiscordAdapter` automatically formats details and errors into beautiful rich embeds.
+
+## 📄 License
+
+MIT License. See [LICENSE](LICENSE) for more details.

script_reporter-0.1.0/README.md

@@ -0,0 +1,85 @@
+# script-reporter 🚀
+
+A lightweight, zero-dependency Python status reporter designed for automation scripts and cron jobs. Easily report execution progress, stages, and results to **Console**, **Discord**, and **Telegram**.
+
+## ✨ Key Features
+
+- **Zero External Dependencies**: Uses Python standard library only (`urllib`).
+- **Multi-Channel**: Simultaneous reporting to Console, Discord (Webhooks), and Telegram (Bot API).
+- **Stage Tracking**: Monitor exactly where your script is (e.g., `SETUP` -> `PROCESSING` -> `COMPLETE`).
+- **Error Transparency**: Automatically attaches tracebacks on failure.
+- **Duration Tracking**: Automatically calculates and reports execution time.
+- **CI/CD & Cron Friendly**: Standardized JSON output for logs makes it easy for other tools to parse.
+
+## 📦 Installation
+
+```bash
+pip install script-reporter
+```
+
+## 🚀 Quick Start
+
+### 1. Simple Usage (Auto-reporitng)
+
+Set simple environment variables to enable channels:
+- `REPORTER_DISCORD_WEBHOOK`: Discord Webhook URL
+- `REPORTER_TELEGRAM_TOKEN` & `REPORTER_TELEGRAM_CHAT_ID`: Telegram Bot Token and Chat ID
+
+```python
+from script_reporter import ScriptReporter
+import traceback
+
+# Initialize with a title (auto-detects Discord/Telegram from Env)
+reporter = ScriptReporter("My Automation Task")
+
+try:
+    # 1. Start a stage
+    reporter.stage("DATA_FETCH")
+    # ... your logic ...
+    
+    # 2. Update stage as you progress
+    reporter.stage("PROCESSING")
+    # ... your logic ...
+    
+    # 3. Report success with optional detail dictionary
+    reporter.success({"items_processed": 100, "status": "all_good"})
+
+except Exception:
+    # 4. Report failure with traceback
+    reporter.fail(traceback.format_exc())
+```
+
+### 2. Manual Configuration
+
+Explicitly control adapters without environment variables:
+
+```python
+from script_reporter import ScriptReporter, ConsoleAdapter, DiscordAdapter, TelegramAdapter
+
+adapters = [
+    ConsoleAdapter(),
+    DiscordAdapter(webhook_url="https://discord.com/api/webhooks/..."),
+    TelegramAdapter(token="BOT_TOKEN", chat_id="CHAT_ID")
+]
+
+reporter = ScriptReporter("Manual Config Task", adapters=adapters)
+reporter.success({"msg": "Hello from code!"})
+```
+
+## 📊 JSON Log Format
+
+`ConsoleAdapter` prints a machine-readable JSON line starting with `__RESULT__`:
+
+```json
+__RESULT__ {"title": "My Task", "host": "server-01", "stage": "COMPLETE", "status": "SUCCESS", "duration": "1m 30s", "detail": {"processed": 5}}
+```
+
+## 🛠 Advanced Concepts
+
+- **Stages**: Use `reporter.stage("NAME")` to track progress. If `reporter.fail()` is called, it identifies the last successful stage.
+- **Duration**: Tracks time from `ScriptReporter()` initialization to `success()`/`fail()` call.
+- **Discord Rich Embeds**: `DiscordAdapter` automatically formats details and errors into beautiful rich embeds.
+
+## 📄 License
+
+MIT License. See [LICENSE](LICENSE) for more details.

script_reporter-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "script-reporter"
+version = "0.1.0"
+authors = [
+    { name = "Yoonbae Cho", email = "y@xcv.kr" },
+]
+description = "A lightweight status reporter for Python scripts with Discord and Telegram support"
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = ["reporter", "notification", "discord", "telegram", "script", "monitoring"]
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/yoonbae81/script-reporter"
+"Bug Tracker" = "https://github.com/yoonbae81/script-reporter/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]

script_reporter-0.1.0/setup.cfg

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

script_reporter-0.1.0/src/script_reporter/__init__.py

@@ -0,0 +1,3 @@
+from .reporter import ScriptReporter, ConsoleAdapter, DiscordAdapter, TelegramAdapter
+
+__all__ = ['ScriptReporter', 'ConsoleAdapter', 'DiscordAdapter', 'TelegramAdapter']

script_reporter-0.1.0/src/script_reporter/adapters/__init__.py

@@ -0,0 +1,6 @@
+from .base import BaseAdapter
+from .console import ConsoleAdapter
+from .discord import DiscordAdapter
+from .telegram import TelegramAdapter
+
+__all__ = ['BaseAdapter', 'ConsoleAdapter', 'DiscordAdapter', 'TelegramAdapter']

script_reporter-0.1.0/src/script_reporter/adapters/base.py

@@ -0,0 +1,3 @@
+class BaseAdapter:
+    def send(self, data):
+        raise NotImplementedError

script_reporter-0.1.0/src/script_reporter/adapters/console.py

@@ -0,0 +1,6 @@
+from .base import BaseAdapter
+
+class ConsoleAdapter(BaseAdapter):
+    def send(self, data):
+        import json
+        print(f"__RESULT__ {json.dumps(data, ensure_ascii=False)}")

script_reporter-0.1.0/src/script_reporter/adapters/discord.py

@@ -0,0 +1,50 @@
+import json
+import os
+import time
+import urllib.request
+from .base import BaseAdapter
+
+class DiscordAdapter(BaseAdapter):
+    def __init__(self, webhook_url=None):
+        self.webhook_url = webhook_url or os.environ.get('REPORTER_DISCORD_WEBHOOK')
+
+    def send(self, result):
+        if not self.webhook_url:
+            return
+            
+        status_emoji = ""  # Removed noisy emojis
+        title = result.get('title', 'Execution')
+        
+        embed = {
+            "title": f"{title} Result: {result['status']}",
+            "color": 0x00ff00 if result['status'] == "SUCCESS" else 0xff0000,
+            "fields": [
+                {"name": "Host", "value": result['host'], "inline": True},
+                {"name": "Stage", "value": result['stage'], "inline": True},
+                {"name": "Duration", "value": result['duration'], "inline": True},
+            ],
+            "timestamp": time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime())
+        }
+        
+        if result.get('detail'):
+            detail_lines = []
+            for key, value in result['detail'].items():
+                label = key.replace('_', ' ').title()
+                detail_lines.append(f"**{label}**: {value}")
+            if detail_lines:
+                embed["description"] = "\n".join(detail_lines)
+            
+        if result['status'] == "FAIL" and result.get('trace'):
+            trace = result['trace']
+            if len(trace) > 1000:
+                trace = trace[:1000] + "..."
+            embed["fields"].append({"name": "Error Trace", "value": f"```python\n{trace}\n```"})
+
+        data = json.dumps({"embeds": [embed]}).encode('utf-8')
+        req = urllib.request.Request(self.webhook_url, data=data, headers={'Content-Type': 'application/json', 'User-Agent': 'Result-Bot'})
+        
+        try:
+            with urllib.request.urlopen(req, timeout=10) as response:
+                pass
+        except Exception as e:
+            print(f"Failed to send Discord notification: {e}")

script_reporter-0.1.0/src/script_reporter/adapters/telegram.py

@@ -0,0 +1,46 @@
+import json
+import os
+import urllib.request
+from .base import BaseAdapter
+
+class TelegramAdapter(BaseAdapter):
+    def __init__(self, token=None, chat_id=None):
+        self.token = token or os.environ.get('REPORTER_TELEGRAM_TOKEN')
+        self.chat_id = chat_id or os.environ.get('REPORTER_TELEGRAM_CHAT_ID')
+
+    def send(self, result):
+        if not self.token or not self.chat_id:
+            return
+            
+        status_emoji = ""  # Removed noisy emojis
+        title = result.get('title', 'Execution')
+        text = f"*{title} Result: {result['status']}*\n\n"
+        text += f"- *Host:* {result['host']}\n"
+        text += f"- *Stage:* {result['stage']}\n"
+        text += f"- *Duration:* {result['duration']}\n"
+        
+        if result.get('detail'):
+            for key, value in result['detail'].items():
+                label = key.replace('_', ' ').title()
+                text += f"- *{label}:* {value}\n"
+            
+        if result['status'] == "FAIL" and result.get('trace'):
+            trace = result['trace']
+            if len(trace) > 500:
+                trace = trace[:500] + "..."
+            text += f"\n*Error Trace:*\n`{trace}`"
+
+        url = f"https://api.telegram.org/bot{self.token}/sendMessage"
+        data = json.dumps({
+            "chat_id": self.chat_id,
+            "text": text,
+            "parse_mode": "Markdown"
+        }).encode('utf-8')
+        
+        req = urllib.request.Request(url, data=data, headers={'Content-Type': 'application/json'})
+        
+        try:
+            with urllib.request.urlopen(req, timeout=10) as response:
+                pass
+        except Exception as e:
+            print(f"Failed to send Telegram notification: {e}")

script_reporter-0.1.0/src/script_reporter/reporter.py

@@ -0,0 +1,67 @@
+import json
+import socket
+import time
+import os
+from .adapters import ConsoleAdapter, DiscordAdapter, TelegramAdapter
+
+class ScriptReporter:
+    def __init__(self, title="Task", adapters=None):
+        self.title = title
+        self.host = socket.gethostname()
+        self.start_time = time.time()
+        self.current_stage = "INIT"
+        
+        if adapters is None:
+            # Default adapters: Console always
+            self.adapters = [ConsoleAdapter()]
+            
+            # Auto-detect Discord
+            if os.environ.get('REPORTER_DISCORD_WEBHOOK'):
+                self.adapters.append(DiscordAdapter())
+                
+            # Auto-detect Telegram
+            if os.environ.get('REPORTER_TELEGRAM_TOKEN') and os.environ.get('REPORTER_TELEGRAM_CHAT_ID'):
+                self.adapters.append(TelegramAdapter())
+        else:
+            self.adapters = adapters
+        
+    def stage(self, stage_name):
+        self.current_stage = stage_name
+        
+    def _get_duration(self):
+        duration_sec = time.time() - self.start_time
+        if duration_sec < 60:
+            return f"{int(duration_sec)}s"
+        else:
+            minutes = int(duration_sec // 60)
+            seconds = int(duration_sec % 60)
+            return f"{minutes}m {seconds}s"
+
+    def _notify(self, result_data):
+        for adapter in self.adapters:
+            try:
+                adapter.send(result_data)
+            except Exception as e:
+                print(f"Adapter {adapter.__class__.__name__} failed: {e}")
+
+    def success(self, detail=None):
+        result_data = {
+            "title": self.title,
+            "host": self.host,
+            "stage": "COMPLETE",
+            "status": "SUCCESS",
+            "duration": self._get_duration(),
+            "detail": detail or {}
+        }
+        self._notify(result_data)
+        
+    def fail(self, error_trace):
+        result_data = {
+            "title": self.title,
+            "host": self.host,
+            "stage": self.current_stage,
+            "status": "FAIL",
+            "duration": self._get_duration(),
+            "trace": error_trace
+        }
+        self._notify(result_data)

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

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: script-reporter
+Version: 0.1.0
+Summary: A lightweight status reporter for Python scripts with Discord and Telegram support
+Author-email: Yoonbae Cho <y@xcv.kr>
+License: MIT
+Project-URL: Homepage, https://github.com/yoonbae81/script-reporter
+Project-URL: Bug Tracker, https://github.com/yoonbae81/script-reporter/issues
+Keywords: reporter,notification,discord,telegram,script,monitoring
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# script-reporter 🚀
+
+A lightweight, zero-dependency Python status reporter designed for automation scripts and cron jobs. Easily report execution progress, stages, and results to **Console**, **Discord**, and **Telegram**.
+
+## ✨ Key Features
+
+- **Zero External Dependencies**: Uses Python standard library only (`urllib`).
+- **Multi-Channel**: Simultaneous reporting to Console, Discord (Webhooks), and Telegram (Bot API).
+- **Stage Tracking**: Monitor exactly where your script is (e.g., `SETUP` -> `PROCESSING` -> `COMPLETE`).
+- **Error Transparency**: Automatically attaches tracebacks on failure.
+- **Duration Tracking**: Automatically calculates and reports execution time.
+- **CI/CD & Cron Friendly**: Standardized JSON output for logs makes it easy for other tools to parse.
+
+## 📦 Installation
+
+```bash
+pip install script-reporter
+```
+
+## 🚀 Quick Start
+
+### 1. Simple Usage (Auto-reporitng)
+
+Set simple environment variables to enable channels:
+- `REPORTER_DISCORD_WEBHOOK`: Discord Webhook URL
+- `REPORTER_TELEGRAM_TOKEN` & `REPORTER_TELEGRAM_CHAT_ID`: Telegram Bot Token and Chat ID
+
+```python
+from script_reporter import ScriptReporter
+import traceback
+
+# Initialize with a title (auto-detects Discord/Telegram from Env)
+reporter = ScriptReporter("My Automation Task")
+
+try:
+    # 1. Start a stage
+    reporter.stage("DATA_FETCH")
+    # ... your logic ...
+    
+    # 2. Update stage as you progress
+    reporter.stage("PROCESSING")
+    # ... your logic ...
+    
+    # 3. Report success with optional detail dictionary
+    reporter.success({"items_processed": 100, "status": "all_good"})
+
+except Exception:
+    # 4. Report failure with traceback
+    reporter.fail(traceback.format_exc())
+```
+
+### 2. Manual Configuration
+
+Explicitly control adapters without environment variables:
+
+```python
+from script_reporter import ScriptReporter, ConsoleAdapter, DiscordAdapter, TelegramAdapter
+
+adapters = [
+    ConsoleAdapter(),
+    DiscordAdapter(webhook_url="https://discord.com/api/webhooks/..."),
+    TelegramAdapter(token="BOT_TOKEN", chat_id="CHAT_ID")
+]
+
+reporter = ScriptReporter("Manual Config Task", adapters=adapters)
+reporter.success({"msg": "Hello from code!"})
+```
+
+## 📊 JSON Log Format
+
+`ConsoleAdapter` prints a machine-readable JSON line starting with `__RESULT__`:
+
+```json
+__RESULT__ {"title": "My Task", "host": "server-01", "stage": "COMPLETE", "status": "SUCCESS", "duration": "1m 30s", "detail": {"processed": 5}}
+```
+
+## 🛠 Advanced Concepts
+
+- **Stages**: Use `reporter.stage("NAME")` to track progress. If `reporter.fail()` is called, it identifies the last successful stage.
+- **Duration**: Tracks time from `ScriptReporter()` initialization to `success()`/`fail()` call.
+- **Discord Rich Embeds**: `DiscordAdapter` automatically formats details and errors into beautiful rich embeds.
+
+## 📄 License
+
+MIT License. See [LICENSE](LICENSE) for more details.

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

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/script_reporter/__init__.py
+src/script_reporter/reporter.py
+src/script_reporter.egg-info/PKG-INFO
+src/script_reporter.egg-info/SOURCES.txt
+src/script_reporter.egg-info/dependency_links.txt
+src/script_reporter.egg-info/top_level.txt
+src/script_reporter/adapters/__init__.py
+src/script_reporter/adapters/base.py
+src/script_reporter/adapters/console.py
+src/script_reporter/adapters/discord.py
+src/script_reporter/adapters/telegram.py

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+script_reporter