gcp-notifier 0.1.2__tar.gz

gcp_notifier-0.1.2/LICENSE

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

gcp_notifier-0.1.2/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

gcp_notifier-0.1.2/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: gcp_notifier
+Version: 0.1.2
+Summary: A simple notification library for Google Cloud projects. Sends alerts via Email and Google Chat.
+Author-email: Marcellus Montilla <marcellusmontilla@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Marcellus Montilla
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/marcellusmontilla/gcp_notifier
+Project-URL: Repository, https://github.com/marcellusmontilla/gcp_notifier
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-cloud-secret-manager
+Requires-Dist: google-auth
+Requires-Dist: requests
+Dynamic: license-file
+
+# GCP Notifier
+
+A simple notification library for Google Cloud projects. Send alerts via Email and Google Chat with a single function call. Designed to be imported and used as a Python module in your own code.
+
+## Features
+
+- Send notifications via Email and Google Chat (Webhook)
+- Unified, simple Python API: `notify(subject, body, channels)`
+- Tenacity-compatible error callback: `notify_on_failure`
+- Secrets are securely loaded from Google Secret Manager
+
+## Installation
+
+Install from PyPI (recommended):
+
+```sh
+pip install gcp-notifier
+```
+
+Or, to test the latest version from TestPyPI:
+
+```sh
+pip install -i https://test.pypi.org/simple/ gcp-notifier
+```
+
+Or, for local development:
+
+```sh
+pip install .
+```
+
+Or add to your requirements.txt:
+
+```text
+gcp_notifier @ git+https://github.com/marcellusmontilla/gcp_notifier.git
+```
+
+## Quick Start
+
+1. Install the package (see Installation above).
+
+2. The account (personal or service) running this code must have the 'Secret Manager Secret Accessor' role in your GCP project.
+
+3. The required secrets must be in the same GCP project where your Python script or notebook is running.
+
+4. Add your required secrets to Google Secret Manager in your GCP project:
+
+   - `GCHAT_WEBHOOK_URL` (for Google Chat)
+   - `EMAIL_SENDER` (sender email address for Email)
+   - `EMAIL_PASSWORD` (password or app password for sender)
+   - `EMAIL_RECIPIENTS` (comma-separated list of recipient email addresses)
+
+5. Import and use `notify` in your code as shown below.
+
+## Usage
+
+Import and use in your Python code:
+
+```python
+from gcp_notifier import notify, notify_on_failure
+
+# Send a notification (choose channels: "email", "gchat", or both)
+notify(
+  subject="Alert Subject",
+  body="Alert body text",
+  channels=["email", "gchat"]  # or ["email"] or ["gchat"]
+)
+
+# Use as tenacity retry_error_callback
+from tenacity import retry, stop_after_attempt
+
+@retry(stop=stop_after_attempt(3), retry_error_callback=notify_on_failure)
+def always_fails():
+  # This function will always fail, triggering notify_on_failure after retries
+  raise ValueError("This is a test error for notification.")
+
+always_fails()
+```
+
+## Building and Publishing
+
+This project uses a modern Python packaging workflow with `pyproject.toml`.
+
+To build the package:
+
+```sh
+python -m pip install --upgrade build
+python -m build
+```
+
+To check and upload to PyPI:
+
+```sh
+python -m pip install --upgrade twine
+twine check dist/*
+twine upload dist/*
+```
+
+See [Python Packaging User Guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/) for more details.
+
+## License
+
+MIT

gcp_notifier-0.1.2/README.md

@@ -0,0 +1,103 @@
+# GCP Notifier
+
+A simple notification library for Google Cloud projects. Send alerts via Email and Google Chat with a single function call. Designed to be imported and used as a Python module in your own code.
+
+## Features
+
+- Send notifications via Email and Google Chat (Webhook)
+- Unified, simple Python API: `notify(subject, body, channels)`
+- Tenacity-compatible error callback: `notify_on_failure`
+- Secrets are securely loaded from Google Secret Manager
+
+## Installation
+
+Install from PyPI (recommended):
+
+```sh
+pip install gcp-notifier
+```
+
+Or, to test the latest version from TestPyPI:
+
+```sh
+pip install -i https://test.pypi.org/simple/ gcp-notifier
+```
+
+Or, for local development:
+
+```sh
+pip install .
+```
+
+Or add to your requirements.txt:
+
+```text
+gcp_notifier @ git+https://github.com/marcellusmontilla/gcp_notifier.git
+```
+
+## Quick Start
+
+1. Install the package (see Installation above).
+
+2. The account (personal or service) running this code must have the 'Secret Manager Secret Accessor' role in your GCP project.
+
+3. The required secrets must be in the same GCP project where your Python script or notebook is running.
+
+4. Add your required secrets to Google Secret Manager in your GCP project:
+
+   - `GCHAT_WEBHOOK_URL` (for Google Chat)
+   - `EMAIL_SENDER` (sender email address for Email)
+   - `EMAIL_PASSWORD` (password or app password for sender)
+   - `EMAIL_RECIPIENTS` (comma-separated list of recipient email addresses)
+
+5. Import and use `notify` in your code as shown below.
+
+## Usage
+
+Import and use in your Python code:
+
+```python
+from gcp_notifier import notify, notify_on_failure
+
+# Send a notification (choose channels: "email", "gchat", or both)
+notify(
+  subject="Alert Subject",
+  body="Alert body text",
+  channels=["email", "gchat"]  # or ["email"] or ["gchat"]
+)
+
+# Use as tenacity retry_error_callback
+from tenacity import retry, stop_after_attempt
+
+@retry(stop=stop_after_attempt(3), retry_error_callback=notify_on_failure)
+def always_fails():
+  # This function will always fail, triggering notify_on_failure after retries
+  raise ValueError("This is a test error for notification.")
+
+always_fails()
+```
+
+## Building and Publishing
+
+This project uses a modern Python packaging workflow with `pyproject.toml`.
+
+To build the package:
+
+```sh
+python -m pip install --upgrade build
+python -m build
+```
+
+To check and upload to PyPI:
+
+```sh
+python -m pip install --upgrade twine
+twine check dist/*
+twine upload dist/*
+```
+
+See [Python Packaging User Guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/) for more details.
+
+## License
+
+MIT

gcp_notifier-0.1.2/gcp_notifier/__init__.py

@@ -0,0 +1,124 @@
+"""
+gcp_notifier: Notification microservice for Email and Google Chat.
+"""
+EMAIL_HOST = "smtp.gmail.com"
+EMAIL_PORT = 587
+__version__ = "0.1.2"
+
+def get_secret(project_id: str, secret_id: str, version_id: str = "latest") -> str:
+    """
+    Retrieve a secret from Google Secret Manager.
+
+    Args:
+        project_id: GCP project ID
+        secret_id: Secret ID in Secret Manager
+        version_id: Version of the secret to retrieve
+
+    Returns:
+        The secret value as a string
+    """
+    from google.cloud import secretmanager
+    client = secretmanager.SecretManagerServiceClient()
+    name = f"projects/{project_id}/secrets/{secret_id}/versions/{version_id}"
+    response = client.access_secret_version(request={"name": name})
+    secret_value = response.payload.data.decode("UTF-8")
+    return secret_value
+
+# Detect GCP project and fetch secrets
+try:
+    import google.auth
+    credentials, project_id = google.auth.default()
+
+    def _fetch_secret_or_none(secret_id: str) -> str:
+        if not project_id:
+            return None
+        try:
+            return get_secret(project_id, secret_id)
+        except Exception as e:
+            print(f"Failed to fetch secret '{secret_id}': {e}")
+            return None
+
+    GCHAT_WEBHOOK_URL = _fetch_secret_or_none("GCHAT_WEBHOOK_URL")
+    EMAIL_SENDER = _fetch_secret_or_none("EMAIL_SENDER")
+    EMAIL_PASSWORD = _fetch_secret_or_none("EMAIL_PASSWORD")
+    EMAIL_RECIPIENTS = _fetch_secret_or_none("EMAIL_RECIPIENTS")
+except Exception:
+    credentials, project_id = None, None
+    GCHAT_WEBHOOK_URL = EMAIL_SENDER = EMAIL_PASSWORD = EMAIL_RECIPIENTS = None
+
+def _send_email(subject: str, message: str) -> None:
+    """Send notification email using configured SMTP credentials."""
+    try:
+        import smtplib
+        from email.message import EmailMessage
+
+        if not EMAIL_RECIPIENTS:
+            print("EMAIL_RECIPIENTS is not set. Cannot send email.")
+            return
+        recipients = [email.strip() for email in EMAIL_RECIPIENTS.split(",") if email.strip()]
+        if not recipients:
+            print("EMAIL_RECIPIENTS is empty. Cannot send email.")
+            return
+        if not EMAIL_SENDER:
+            print("EMAIL_SENDER is not set. Cannot send email.")
+            return
+
+        msg = EmailMessage()
+        msg['From'] = EMAIL_SENDER
+        msg['To'] = ", ".join(recipients)
+        msg['Subject'] = subject
+        msg.set_content(message)
+
+        with smtplib.SMTP(EMAIL_HOST, EMAIL_PORT) as server:
+            server.ehlo()
+            server.starttls()
+            server.ehlo()
+            server.login(EMAIL_SENDER, EMAIL_PASSWORD)
+            server.send_message(msg)
+        print("Email sent successfully!")
+    except Exception as e:
+        print(f"Failed to send email: {e}")
+
+def _send_gchat_alert(message: str) -> None:
+    """Send a notification to Google Chat via Webhook."""
+    try:
+        import requests
+        payload = {"text": message}
+        headers = {"Content-Type": "application/json"}
+        response = requests.post(GCHAT_WEBHOOK_URL, json=payload, headers=headers)
+        if response.status_code == 200:
+            print("GChat alert sent successfully!")
+        else:
+            print(f"Failed to send GChat alert: {response.text}")
+    except Exception as e:
+        print(f"Failed to send GChat alert: {e}")
+
+def notify(subject: str, body: str, channels: list[str] = ["email", "gchat"]) -> None:
+    """
+    Send a notification via email, Google Chat, or both.
+
+    Args:
+        subject: The subject for email (ignored for gchat)
+        body: The message body
+        channels: List of channels to send to ("email", "gchat")
+    """
+    if not channels:
+        print("No channels specified. Nothing to send.")
+        return
+    if "email" in channels:
+        _send_email(subject, body)
+    if "gchat" in channels:
+        _send_gchat_alert(body)
+
+# Expose functions for import
+def notify_on_failure(retry_state) -> None:
+    """
+    Tenacity retry_error_callback to send notification on final failure.
+    Usage: @retry(..., retry_error_callback=notify_on_failure)
+    """
+    fn_name = getattr(retry_state.fn, "__name__", str(retry_state.fn))
+    exception = retry_state.outcome.exception() if retry_state.outcome else None
+    msg = f"Function '{fn_name}' failed after retries. Exception: {exception}"
+    notify(subject=f"Failure in {fn_name}", body=msg, channels=["email", "gchat"])
+
+__all__ = ["notify", "project_id", "notify_on_failure"]

gcp_notifier-0.1.2/gcp_notifier.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: gcp_notifier
+Version: 0.1.2
+Summary: A simple notification library for Google Cloud projects. Sends alerts via Email and Google Chat.
+Author-email: Marcellus Montilla <marcellusmontilla@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Marcellus Montilla
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/marcellusmontilla/gcp_notifier
+Project-URL: Repository, https://github.com/marcellusmontilla/gcp_notifier
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-cloud-secret-manager
+Requires-Dist: google-auth
+Requires-Dist: requests
+Dynamic: license-file
+
+# GCP Notifier
+
+A simple notification library for Google Cloud projects. Send alerts via Email and Google Chat with a single function call. Designed to be imported and used as a Python module in your own code.
+
+## Features
+
+- Send notifications via Email and Google Chat (Webhook)
+- Unified, simple Python API: `notify(subject, body, channels)`
+- Tenacity-compatible error callback: `notify_on_failure`
+- Secrets are securely loaded from Google Secret Manager
+
+## Installation
+
+Install from PyPI (recommended):
+
+```sh
+pip install gcp-notifier
+```
+
+Or, to test the latest version from TestPyPI:
+
+```sh
+pip install -i https://test.pypi.org/simple/ gcp-notifier
+```
+
+Or, for local development:
+
+```sh
+pip install .
+```
+
+Or add to your requirements.txt:
+
+```text
+gcp_notifier @ git+https://github.com/marcellusmontilla/gcp_notifier.git
+```
+
+## Quick Start
+
+1. Install the package (see Installation above).
+
+2. The account (personal or service) running this code must have the 'Secret Manager Secret Accessor' role in your GCP project.
+
+3. The required secrets must be in the same GCP project where your Python script or notebook is running.
+
+4. Add your required secrets to Google Secret Manager in your GCP project:
+
+   - `GCHAT_WEBHOOK_URL` (for Google Chat)
+   - `EMAIL_SENDER` (sender email address for Email)
+   - `EMAIL_PASSWORD` (password or app password for sender)
+   - `EMAIL_RECIPIENTS` (comma-separated list of recipient email addresses)
+
+5. Import and use `notify` in your code as shown below.
+
+## Usage
+
+Import and use in your Python code:
+
+```python
+from gcp_notifier import notify, notify_on_failure
+
+# Send a notification (choose channels: "email", "gchat", or both)
+notify(
+  subject="Alert Subject",
+  body="Alert body text",
+  channels=["email", "gchat"]  # or ["email"] or ["gchat"]
+)
+
+# Use as tenacity retry_error_callback
+from tenacity import retry, stop_after_attempt
+
+@retry(stop=stop_after_attempt(3), retry_error_callback=notify_on_failure)
+def always_fails():
+  # This function will always fail, triggering notify_on_failure after retries
+  raise ValueError("This is a test error for notification.")
+
+always_fails()
+```
+
+## Building and Publishing
+
+This project uses a modern Python packaging workflow with `pyproject.toml`.
+
+To build the package:
+
+```sh
+python -m pip install --upgrade build
+python -m build
+```
+
+To check and upload to PyPI:
+
+```sh
+python -m pip install --upgrade twine
+twine check dist/*
+twine upload dist/*
+```
+
+See [Python Packaging User Guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/) for more details.
+
+## License
+
+MIT

gcp_notifier-0.1.2/gcp_notifier.egg-info/SOURCES.txt

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

gcp_notifier-0.1.2/gcp_notifier.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gcp_notifier-0.1.2/gcp_notifier.egg-info/requires.txt

@@ -0,0 +1,3 @@
+google-cloud-secret-manager
+google-auth
+requests

gcp_notifier-0.1.2/gcp_notifier.egg-info/top_level.txt

@@ -0,0 +1 @@
+gcp_notifier

gcp_notifier-0.1.2/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gcp_notifier"
+version = "0.1.2"
+description = "A simple notification library for Google Cloud projects. Sends alerts via Email and Google Chat."
+authors = [
+  { name = "Marcellus Montilla", email = "marcellusmontilla@gmail.com" }
+]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.8"
+dependencies = [
+  "google-cloud-secret-manager",
+  "google-auth",
+  "requests"
+]
+
+[project.urls]
+Homepage = "https://github.com/marcellusmontilla/gcp_notifier"
+Repository = "https://github.com/marcellusmontilla/gcp_notifier"

gcp_notifier-0.1.2/setup.cfg

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