teams-alerter 0.1.0__tar.gz

teams_alerter-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: teams-alerter
+Version: 0.1.0
+Summary: Module pour envoyer des alertes Teams via Pub/Sub
+Author-email: Toki <t.bakotondrabe-ext@paris-turf.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: google-cloud-logging
+Requires-Dist: google-cloud-pubsub
+
+# 🛠️ Teams Alerter
+
+A lightweight Python module to send alerts to Microsoft Teams via Google Cloud Pub/Sub.
+
+---
+
+## 📦 How to Build the Module
+
+Make sure you have the `build` package installed:
+
+```bash
+python -m pip install --upgrade build
+python -m build
+```
+
+This will generate `.whl` and `.tar.gz` files inside the `dist/` folder.
+
+---
+
+## 🔧 Install the Module Locally
+
+From your project directory (with your virtual environment activated):
+
+```bash
+pip install ../teams-alerter/dist/teams_alerter-0.1.0-py3-none-any.whl
+```
+
+> Adjust the path according to your actual `.whl` file location.
+
+---
+
+## 🚀 How to Use the Module
+
+```python
+from teams_alerter import TeamsAlerter
+
+# Example: error handling
+try:
+    raise RuntimeError("Test error")
+except Exception as error:
+    TeamsAlerter.handle_error(error, utils)
+```
+
+---
+
+## 📤 How to Publish to PyPI
+
+1. Install `twine`:
+
+```bash
+pip install twine
+```
+
+2. Upload the distribution files:
+
+```bash
+twine upload dist/*
+```
+
+> A PyPI account is required: https://pypi.org/account/register/
+
+---
+
+## 📁 Recommended Module Structure
+
+```
+teams-alerter/
+├── src/
+│   └── teams_alerter/
+│       ├── __init__.py
+│       ├── core.py
+│       └── utils.py
+├── pyproject.toml
+├── README.md
+└── dist/
+```
+
+---
+
+## ✅ Requirements
+
+- Python ≥ 3.8
+- Google Cloud SDK if you are using Pub/Sub
+- Dependencies:
+  - `google-cloud-logging`
+  - `google-cloud-pubsub`
+
+These dependencies are already listed in your `pyproject.toml`.
+
+---

teams_alerter-0.1.0/README.md

@@ -0,0 +1,90 @@
+# 🛠️ Teams Alerter
+
+A lightweight Python module to send alerts to Microsoft Teams via Google Cloud Pub/Sub.
+
+---
+
+## 📦 How to Build the Module
+
+Make sure you have the `build` package installed:
+
+```bash
+python -m pip install --upgrade build
+python -m build
+```
+
+This will generate `.whl` and `.tar.gz` files inside the `dist/` folder.
+
+---
+
+## 🔧 Install the Module Locally
+
+From your project directory (with your virtual environment activated):
+
+```bash
+pip install ../teams-alerter/dist/teams_alerter-0.1.0-py3-none-any.whl
+```
+
+> Adjust the path according to your actual `.whl` file location.
+
+---
+
+## 🚀 How to Use the Module
+
+```python
+from teams_alerter import TeamsAlerter
+
+# Example: error handling
+try:
+    raise RuntimeError("Test error")
+except Exception as error:
+    TeamsAlerter.handle_error(error, utils)
+```
+
+---
+
+## 📤 How to Publish to PyPI
+
+1. Install `twine`:
+
+```bash
+pip install twine
+```
+
+2. Upload the distribution files:
+
+```bash
+twine upload dist/*
+```
+
+> A PyPI account is required: https://pypi.org/account/register/
+
+---
+
+## 📁 Recommended Module Structure
+
+```
+teams-alerter/
+├── src/
+│   └── teams_alerter/
+│       ├── __init__.py
+│       ├── core.py
+│       └── utils.py
+├── pyproject.toml
+├── README.md
+└── dist/
+```
+
+---
+
+## ✅ Requirements
+
+- Python ≥ 3.8
+- Google Cloud SDK if you are using Pub/Sub
+- Dependencies:
+  - `google-cloud-logging`
+  - `google-cloud-pubsub`
+
+These dependencies are already listed in your `pyproject.toml`.
+
+---

teams_alerter-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[project]
+name = "teams-alerter"
+version = "0.1.0"
+description = "Module pour envoyer des alertes Teams via Pub/Sub"
+authors = [{ name = "Toki", email = "t.bakotondrabe-ext@paris-turf.com" }]
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "google-cloud-logging",
+    "google-cloud-pubsub",
+]
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

teams_alerter-0.1.0/setup.cfg

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

teams_alerter-0.1.0/src/__init__.py

@@ -0,0 +1,4 @@
+from .core import TeamsAlerter
+from .utils import DateUtils, ErrorUtils
+
+__all__ = ["TeamsAlerter", "DateUtils", "ErrorUtils"]

teams_alerter-0.1.0/src/core.py

@@ -0,0 +1,77 @@
+import json
+import traceback
+
+from google.cloud import pubsub_v1
+from utils import ErrorUtils, DateUtils
+
+
+class TeamsAlerter:
+    def __init__(
+        self,
+        utils,
+        app_name,
+        teams_channel,
+        detail,
+        level,
+        environment=None,
+        url_log=None,
+        timestamp=None,
+        teams_template=None,
+    ):
+        self.utils = utils
+        self.app_name = app_name
+        self.teams_channel = teams_channel
+        self.detail = detail
+        self.environment = environment
+        self.level = level
+        self.timestamp = timestamp
+        self.url_log = url_log
+        self.teams_template = teams_template
+
+    @staticmethod
+    def handle_error(error: Exception, utils: ErrorUtils) -> None:
+        error_type = type(error).__name__
+        error_message = str(error)
+        error_traceback = traceback.format_exc()
+
+        teams_alerter = TeamsAlerter(
+            utils=utils,
+            app_name="datastream-transaction-pub",
+            teams_channel=f"datastream-{utils['env']}-alerts",
+            detail=f"Error type: {error_type}\nError message: {error_message}\nError traceback: {error_traceback}",
+            level="ERROR",
+        )
+
+        teams_alerter.publish_alert()
+
+    def publish_alert(self):
+        # Formatage du payload
+        utc_timestamp_minus_5min = DateUtils.get_str_utc_timestamp_minus_5min()
+        utc_timestamp = DateUtils.get_str_utc_timestamp()
+        payload = json.dumps(
+            {
+                "app_name": self.app_name,
+                "teams_channel": self.teams_channel,
+                "detail": self.detail,
+                "level": self.level,
+                "environment": self.utils["env"],
+                "url_log": f"https://console.cloud.google.com/logs/query;query=resource.type%3D%22gce_instance%22%0Aresource.labels.project_id%3D%22{self.utils['app_project_id']}%22;cursorTimestamp={utc_timestamp_minus_5min};duration=PT10M?referrer=search&hl=fr&inv=1&invt=Ab3WcQ&project={self.utils['app_project_id']}",
+                "timestamp": utc_timestamp,
+                "teams_template": "card",
+            }
+        )
+
+        # Création d'un éditeur
+        publisher = pubsub_v1.PublisherClient()
+        topic_path = publisher.topic_path(self.utils["topic_project_id"], self.utils["topic_id"])
+
+        # Message à publier
+        data = payload.encode("utf-8")
+
+        # Publier le message
+        try:
+            publish_future = publisher.publish(topic_path, data)
+            publish_future.result()
+
+        except Exception as e:
+            self.utils["logger"](f"🟥Une erreur s'est produite lors de la publication du message : {e}")

teams_alerter-0.1.0/src/setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="teams-alerter",
+    version="0.1.0",
+    packages=find_packages(),
+    install_requires=[
+        "google-cloud-logging",
+        "google-cloud-pubsub",
+    ],
+)

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

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: teams-alerter
+Version: 0.1.0
+Summary: Module pour envoyer des alertes Teams via Pub/Sub
+Author-email: Toki <t.bakotondrabe-ext@paris-turf.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: google-cloud-logging
+Requires-Dist: google-cloud-pubsub
+
+# 🛠️ Teams Alerter
+
+A lightweight Python module to send alerts to Microsoft Teams via Google Cloud Pub/Sub.
+
+---
+
+## 📦 How to Build the Module
+
+Make sure you have the `build` package installed:
+
+```bash
+python -m pip install --upgrade build
+python -m build
+```
+
+This will generate `.whl` and `.tar.gz` files inside the `dist/` folder.
+
+---
+
+## 🔧 Install the Module Locally
+
+From your project directory (with your virtual environment activated):
+
+```bash
+pip install ../teams-alerter/dist/teams_alerter-0.1.0-py3-none-any.whl
+```
+
+> Adjust the path according to your actual `.whl` file location.
+
+---
+
+## 🚀 How to Use the Module
+
+```python
+from teams_alerter import TeamsAlerter
+
+# Example: error handling
+try:
+    raise RuntimeError("Test error")
+except Exception as error:
+    TeamsAlerter.handle_error(error, utils)
+```
+
+---
+
+## 📤 How to Publish to PyPI
+
+1. Install `twine`:
+
+```bash
+pip install twine
+```
+
+2. Upload the distribution files:
+
+```bash
+twine upload dist/*
+```
+
+> A PyPI account is required: https://pypi.org/account/register/
+
+---
+
+## 📁 Recommended Module Structure
+
+```
+teams-alerter/
+├── src/
+│   └── teams_alerter/
+│       ├── __init__.py
+│       ├── core.py
+│       └── utils.py
+├── pyproject.toml
+├── README.md
+└── dist/
+```
+
+---
+
+## ✅ Requirements
+
+- Python ≥ 3.8
+- Google Cloud SDK if you are using Pub/Sub
+- Dependencies:
+  - `google-cloud-logging`
+  - `google-cloud-pubsub`
+
+These dependencies are already listed in your `pyproject.toml`.
+
+---

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

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/__init__.py
+src/core.py
+src/setup.py
+src/utils.py
+src/teams_alerter.egg-info/PKG-INFO
+src/teams_alerter.egg-info/SOURCES.txt
+src/teams_alerter.egg-info/dependency_links.txt
+src/teams_alerter.egg-info/requires.txt
+src/teams_alerter.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

teams_alerter-0.1.0/src/teams_alerter.egg-info/requires.txt

@@ -0,0 +1,2 @@
+google-cloud-logging
+google-cloud-pubsub

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

@@ -0,0 +1,4 @@
+__init__
+core
+setup
+utils

teams_alerter-0.1.0/src/utils.py

@@ -0,0 +1,24 @@
+import datetime
+
+from typing import TypedDict
+from google.cloud import logging
+
+
+class ErrorUtils(TypedDict):
+    logger: logging.Logger
+    env: str
+    app_project_id: str
+    topic_project_id: str
+    topic_id: str
+
+
+class DateUtils:
+    @staticmethod
+    def get_str_utc_timestamp():
+        dt = datetime.datetime.utcnow()
+        return dt.strftime("%Y-%m-%dT%H:%M:%S") + ".000000000Z"
+
+    @staticmethod
+    def get_str_utc_timestamp_minus_5min():
+        dt = datetime.datetime.utcnow() - datetime.timedelta(minutes=5)
+        return dt.strftime("%Y-%m-%dT%H:%M:%S") + ".000000000Z"