initial commit

Author: psyb0t

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    assignees:
+      - "psyb0t"
+    labels:
+      - "dependencies"
+      - "automated pr"

.github/workflows/pipeline.yml

@@ -0,0 +1,16 @@
+name: pipeline
+
+on: [push]
+
+jobs:
+  call-python-package-workflow:
+    uses: psyb0t/reusable-github-workflows/.github/workflows/python-package-workflow.yml@master
+
+    with:
+      python_version: "3.12.0"
+      install_dependencies_command: "make dep"
+      build_command: "make build"
+      dist_dir: "dist"
+
+    secrets:
+      pypi_api_token: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+venv
+__pycache__
+dist

LICENSE

@@ -0,0 +1,14 @@
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2024 Ciprian Mandache <ciprian.51k.eu - psyb0t@51k.eu>
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

Makefile

@@ -0,0 +1,13 @@
+.PHONY: dep build clean help
+
+dep: ## Install dependencies
+	python -m pip install build
+
+build: ## Build the project
+	python -m build
+
+clean: ## Clean the build artifacts
+	rm -rf ./dist
+
+help: ## Display this help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

README.md

@@ -0,0 +1,148 @@
+# 🚀 telegram-logger-client: Your Log's New Best Friend
+
+Welcome to the telegram-logger-client - where your logs go to become stars!
+
+## 🛠 Prerequisites
+
+Before you dive in, make sure you've got your backstage pass ready:
+
+1. You'll need to set up and run the telegram-logger service. It's like the bouncer at the club - without it, your logs aren't getting in.
+
+2. Head over to [https://github.com/psyb0t/telegram-logger](https://github.com/psyb0t/telegram-logger) for the VIP instructions on setting up the telegram-logger service.
+
+3. Once you've got that service up and running, come back here and let's make some noise!
+
+## 🎭 Installation (No Secret Handshake Required)
+
+Install this badass as a module and executable:
+
+```shell
+pip install telegram-logger-client
+```
+
+Go with `pipx` to just use it as an executable:
+
+```shell
+pipx install telegram-logger-client
+```
+
+## 🕹️ Usage (AKA How to Make Some Noise)
+
+### 🐍 As a Python Module
+
+Summon the TelegramLoggerClient in your Python code:
+
+```python
+from telegram_logger_client import TelegramLoggerClient
+
+# Create your logger
+logger = TelegramLoggerClient("https://your-logger-url.com", "your-secret-token")
+
+# Send a log (it's like tweeting, but geekier)
+logger.send_log(
+    caller="CoffeeBot",
+    level="warning",
+    message="Coffee levels critically low!",
+    error="Caffeine deficiency detected",
+    request_id="coffee-run-42",
+    trace_id="from-bed-to-coffee-machine",
+    span_id="mug-to-mouth",
+    data={"coffee_type": "Espresso", "sugar": False, "milk": "Oat"}
+)
+```
+
+### 🖥️ Command Line Magic
+
+First, set up your secret lair:
+
+```shell
+export TELEGRAM_LOGGER_BASE_URL=https://your-logger-url.com
+export TELEGRAM_LOGGER_X_ID=your-secret-token
+```
+
+Now, shout into the void (or just send a log):
+
+```shell
+telegram-logger-client \
+    --caller "WeatherBot" \
+    --level "info" \
+    --message "It's raining cats and dogs!" \
+    --error "Umbrella malfunction" \
+    --request-id "weather-101" \
+    --trace-id "cloud-to-ground" \
+    --span-id "drop-to-splash" \
+    --data '{"temperature": "chilly", "wind": "breezy"}'
+```
+
+Want to see every little detail? Add the `--debug` flag:
+
+```shell
+telegram-logger-client \
+    --debug \
+    --caller "WeatherBot" \
+    --level "info" \
+    --message "It's raining cats and dogs!"
+```
+
+## 🎭 Logging Levels (Choose Your Adventure)
+
+The client itself has two modes:
+
+- Normal Mode (default): "Just the highlights" mode
+- Debug Mode: "I can hear a pin drop" mode
+
+Your logs, on the other hand, can be as dramatic as you want:
+
+- "info": "Just FYI" level
+- "warning": "Hmm, that's interesting" level
+- "error": "Houston, we have a problem" level
+
+## 🧙‍♂️ API Reference (The Boring but Important Bit)
+
+### 🔮 TelegramLoggerClient
+
+#### `__init__(base_url: str, x_id: str)`
+
+Create your logger. Feed it URLs and tokens.
+
+#### `send_log(...)`
+
+Send your log on a grand adventure. Pack its bags with:
+
+- `caller`: Who's making all this noise?
+- `level`: How important is this, really?
+- `message`: What's the scoop?
+- `error`: What went boom?
+- `request_id`: A unique ID for this particular escapade
+- `trace_id`: For retracing your steps
+- `span_id`: A slice of time in the grand timeline
+- `data`: Any extra bits and bobs
+
+Returns a `requests.Response` object (a postcard from your log's journey).
+
+## 🗝️ Environment Variables (Your Logger's Secret Code)
+
+- `TELEGRAM_LOGGER_BASE_URL`: Where your logs call home
+- `TELEGRAM_LOGGER_X_ID`: Your logger's super-secret identity
+
+## 🎲 Command Line Arguments (For When You're Feeling Bossy)
+
+- `--debug`: Unleash the full power of logging (optional)
+- `--base-url`: A new home for your logs
+- `--x-id`: A new secret identity
+- `--caller`: Who's calling?
+- `--level`: On a scale of "meh" to "THE WORLD IS ENDING!"
+- `--message`: Your log's 15 minutes of fame
+- `--error`: What's gone sideways?
+- `--request-id`: This log's personal serial number
+- `--trace-id`: Breadcrumbs in the digital forest
+- `--span-id`: A moment in time
+- `--data`: Everything else but the kitchen sink
+
+Remember: Command line arguments are the divas of the coding world - they always steal the show from environment variables.
+
+## 📜 License (The Fine Print)
+
+This project is unleashed under the WTFPL License – Do What The F\*\*k You Want To Public License. Your imagination is the only limit, push it to the boundaries!
+
+Now go forth and log like there's no tomorrow! May your errors be few and your insights be plentiful. Happy logging! 📝🚀

pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "telegram-logger-client"
+version = "0.1.0"
+authors = [{ name = "Ciprian Mandache", email = "psyb0t@51k.eu" }]
+description = "A Python client for the telegram-logger service"
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+dependencies = ["requests>=2.32.3"]
+
+[project.urls]
+Homepage = "https://github.com/psyb0t/py-telegram-logger-client"
+Issues = "https://github.com/psyb0t/py-telegram-logger-client/issues"
+
+[project.scripts]
+telegram-logger-client = "telegram_logger_client.__main__:main"

telegram_logger_client/__init__.py

@@ -0,0 +1 @@
+from .telegram_logger_client import TelegramLoggerClient

telegram_logger_client/__main__.py

@@ -0,0 +1,89 @@
+import argparse
+import json
+import os
+import sys
+import logging
+from .telegram_logger_client import TelegramLoggerClient
+
+
+def setup_logging(debug=False):
+    log_level = logging.DEBUG if debug else logging.INFO
+    logging.basicConfig(
+        level=log_level,
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+    logger = logging.getLogger(__name__)
+    logger.debug(f"Logging level set to: {logging.getLevelName(log_level)}")
+    return logger
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Send logs to telegram-logger service")
+    parser.add_argument("--debug", action="store_true", help="Enable debug logging")
+    parser.add_argument("--base-url", help="Base URL of the telegram-logger service")
+    parser.add_argument("--x-id", help="X-ID token for authentication")
+    parser.add_argument(
+        "--caller", required=True, help="Name of the calling application or service"
+    )
+    parser.add_argument(
+        "--level", required=True, choices=["info", "warning", "error"], help="Log level"
+    )
+    parser.add_argument("--message", required=True, help="Log message")
+    parser.add_argument("--error", help="Error message or description")
+    parser.add_argument("--request-id", help="Request ID for tracing")
+    parser.add_argument("--trace-id", help="Trace ID for distributed tracing")
+    parser.add_argument("--span-id", help="Span ID for distributed tracing")
+    parser.add_argument(
+        "--data", type=json.loads, help="Additional data as JSON string"
+    )
+
+    args = parser.parse_args()
+    logger = setup_logging(args.debug)
+
+    logger.debug(f"Parsed arguments: {args}")
+
+    # Get base_url and x_id from environment variables or command-line arguments
+    base_url = args.base_url or os.environ.get("TELEGRAM_LOGGER_BASE_URL")
+    x_id = args.x_id or os.environ.get("TELEGRAM_LOGGER_X_ID")
+
+    logger.debug(f"Base URL: {base_url}")
+    logger.debug(
+        f"X-ID: {'*' * len(x_id) if x_id else None}"
+    )  # Mask the actual X-ID for security
+
+    if not base_url:
+        logger.error(
+            "Base URL is required. Set TELEGRAM_LOGGER_BASE_URL environment variable or use --base-url argument."
+        )
+        sys.exit(1)
+
+    if not x_id:
+        logger.error(
+            "X-ID is required. Set TELEGRAM_LOGGER_X_ID environment variable or use --x-id argument."
+        )
+        sys.exit(1)
+
+    client = TelegramLoggerClient(base_url, x_id)
+    logger.debug("TelegramLoggerClient initialized")
+
+    try:
+        logger.debug("Attempting to send log")
+        response = client.send_log(
+            caller=args.caller,
+            level=args.level,
+            message=args.message,
+            error=args.error,
+            request_id=args.request_id,
+            trace_id=args.trace_id,
+            span_id=args.span_id,
+            data=args.data,
+        )
+        logger.debug(f"Log sent successfully. Status code: {response.status_code}")
+    except Exception as e:
+        logger.error(f"Error sending log: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

telegram_logger_client/telegram_logger_client.py

@@ -0,0 +1,41 @@
+import json
+import requests
+import datetime
+from typing import Any, Dict, Optional
+
+
+class TelegramLoggerClient:
+    def __init__(self, base_url: str, x_id: str):
+        self.base_url = base_url
+        self.x_id = x_id
+
+    def send_log(
+        self,
+        caller: str,
+        level: str,
+        message: str,
+        error: Optional[str] = None,
+        request_id: Optional[str] = None,
+        trace_id: Optional[str] = None,
+        span_id: Optional[str] = None,
+        data: Optional[Dict[str, Any]] = None,
+    ) -> requests.Response:
+        payload = {
+            "caller": caller,
+            "time": datetime.datetime.now().isoformat(),
+            "level": level,
+            "message": message,
+            "error": error,
+            "requestID": request_id,
+            "traceID": trace_id,
+            "spanID": span_id,
+            "data": data or {},
+        }
+
+        headers = {"Content-Type": "application/json", "X-ID": self.x_id}
+
+        response = requests.post(
+            self.base_url, headers=headers, data=json.dumps(payload)
+        )
+        response.raise_for_status()
+        return response