Merge pull request #30 from mauvehed/chore/fly-deploy

Chore/fly deploy

.dockerignore

@@ -0,0 +1,175 @@
+# flyctl launch added from .gitignore
+# Created by https://www.toptal.com/developers/gitignore/api/flask,python,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=flask,python,visualstudiocode
+
+### Deployment Providers ###
+**/.vercel
+
+### Flask ###
+**/instance/*
+!**/instance/.gitignore
+**/.webassets-cache
+**/.env
+
+### Flask.Python Stack ###
+# Byte-compiled / optimized / DLL files
+**/__pycache__
+**/*.py[cod]
+**/*$py.class
+
+# Distribution / packaging
+**/.Python
+**/build
+**/develop-eggs
+**/dist
+**/downloads
+**/eggs
+**/.eggs
+**/lib
+**/lib64
+**/parts
+**/sdist
+**/var
+**/wheels
+**/share/python-wheels
+**/*.egg-info
+**/.installed.cfg
+**/*.egg
+**/MANIFEST
+**/*.lock
+# allow poetry.lock
+!**/poetry.lock
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+**/*.manifest
+**/*.spec
+
+# Installer logs
+**/pip-log.txt
+**/pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+**/htmlcov
+**/.tox
+**/.nox
+**/.coverage
+**/.coverage.*
+**/.cache
+**/nosetests.xml
+**/coverage.xml
+**/*.cover
+**/*.py,cover
+**/.hypothesis
+**/.pytest_cache
+**/cover
+
+# Translations
+**/*.mo
+**/*.pot
+
+# Django stuff:
+**/*.log
+**/local_settings.py
+**/db.sqlite3
+**/db.sqlite3-journal
+
+# Flask stuff:
+**/instance
+
+# Scrapy stuff:
+**/.scrapy
+
+# Sphinx documentation
+**/docs/_build
+
+# PyBuilder
+**/.pybuilder
+**/target
+
+# Jupyter Notebook
+**/.ipynb_checkpoints
+
+# IPython
+**/profile_default
+**/ipython_config.py
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+**/__pypackages__
+
+# Celery stuff
+**/celerybeat-schedule
+**/celerybeat.pid
+
+# SageMath parsed files
+**/*.sage.py
+
+# Environments
+**/.venv
+**/.env
+**/venv
+**/.direnv
+**/.envrc
+
+# Spyder project settings
+**/.spyderproject
+**/.spyproject
+
+# Rope project settings
+**/.ropeproject
+
+# mkdocs documentation
+site
+
+# mypy
+**/.mypy_cache
+**/.dmypy.json
+**/dmypy.json
+
+# Pyre type checker
+**/.pyre
+
+# pytype static type analyzer
+**/.pytype
+
+# Cython debug symbols
+**/cython_debug
+
+### VisualStudioCode ###
+**/.vscode/*
+!**/.vscode/settings.json
+!**/.vscode/tasks.json
+!**/.vscode/launch.json
+!**/.vscode/extensions.json
+!**/.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+**/.history
+
+# Built Visual Studio Code Extensions
+**/*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+**/.history
+**/.ionide
+
+# Support for Project snippet scope
+**/.vscode/*.code-snippets
+
+# Ignore code-workspaces
+**/*.code-workspace
+
+# Snyk vuln scanner
+**/.dccache
+
+# Config file
+**/config.ini
+
+# End of https://www.toptal.com/developers/gitignore/api/flask,python,visualstudiocode
+
+# flyctl launch added from .mypy_cache/.gitignore
+# Automatically created by mypy
+.mypy_cache/**/*
+fly.toml

.github/workflows/fly-deploy.yml

@@ -0,0 +1,18 @@
+# See https://fly.io/docs/app-guides/continuous-deployment-with-github-actions/
+
+name: Fly Deploy
+on:
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    concurrency: deploy-group    # optional: ensure only one action runs at a time
+    steps:
+      - uses: actions/checkout@v4
+      - uses: superfly/flyctl-actions/setup-flyctl@master
+      - run: flyctl deploy --remote-only
+        env:
+          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

bm_monitor.py

@@ -64,6 +64,17 @@
 
 # Handle graceful shutdown on Ctrl+C or SIGTERM
 def signal_handler(sig, frame):
+    """Handles system signal interrupts for graceful application shutdown.
+
+    This function is designed to intercept system signals and perform a clean disconnection from the socket connection before terminating the application. It ensures that resources are properly released and the application exits smoothly.
+
+    Args:
+        sig (int): The signal number received.
+        frame (frame): The current stack frame.
+
+    Returns:
+        None
+    """
     logging.info("Shutting down gracefully...")
     sio.disconnect()
     sys.exit(0)
@@ -73,18 +84,26 @@ def signal_handler(sig, frame):
 
 # Send push notification via Pushover. Disabled if not configured in config.py
 def push_pushover(msg):
-    try:
-        conn = http.client.HTTPSConnection("api.pushover.net:443")
-        conn.request("POST", "/1/messages.json",
-            urllib.parse.urlencode({
-            "token": cfg.pushover_token,
-            "user": cfg.pushover_user,
-            "message": msg,
-            }), { "Content-type": "application/x-www-form-urlencoded" })
-        conn.getresponse()
-        logging.info("Pushover notification sent.")
-    except Exception as e:
-        logging.error(f"Failed to send Pushover notification: {e}")
+    """Sends a notification to a Discord channel or thread via webhook.
+
+    This function sends a message to a specified Discord webhook URL, with optional support for posting to a specific thread. It utilizes the discord-webhook library to execute the webhook request.
+
+    Args:
+        wh_url (str): The Discord webhook URL.
+        msg (str): The message content to be sent.
+        thread_id (str, optional): The thread ID for posting to a specific thread. Defaults to None.
+
+    Returns:
+        None
+    """
+    conn = http.client.HTTPSConnection("api.pushover.net:443")
+    conn.request("POST", "/1/messages.json",
+        urllib.parse.urlencode({
+        "token": cfg.pushover_token,
+        "user": cfg.pushover_user,
+        "message": msg,
+        }), { "Content-type": "application/x-www-form-urlencoded" })
+    conn.getresponse()
 
 # Send notification to Discord Channel or Thread via webhook
 def push_discord(wh_url, msg, thread_id=None):
@@ -105,15 +124,38 @@ def push_discord(wh_url, msg, thread_id=None):
 
 # Send pager notification via DAPNET. Disabled if not configured in config.py
 def push_dapnet(msg):
-    try:
-        dapnet_json = json.dumps({"text": msg, "callSignNames": cfg.dapnet_callsigns, "transmitterGroupNames": [cfg.dapnet_txgroup], "emergency": True})
-        response = requests.post(cfg.dapnet_url, data=dapnet_json, auth=HTTPBasicAuth(cfg.dapnet_user,cfg.dapnet_pass))
-        logging.info("DAPNET notification sent.")
-    except Exception as e:
-        logging.error(f"Failed to send DAPNET notification: {e}")
+    """Sends a pager notification via the DAPNET (Digital Amateur Paging Network) service.
+
+    This function sends an emergency text message to specified DAPNET callsigns and transmitter groups using the configured DAPNET credentials. It prepares a JSON payload and submits a POST request to the DAPNET API.
+
+    Args:
+        msg (str): The message content to be sent via DAPNET.
+
+    Returns:
+        None
+    """
+    dapnet_json = json.dumps({"text": msg, "callSignNames": cfg.dapnet_callsigns, "transmitterGroupNames": [cfg.dapnet_txgroup], "emergency": True})
+    response = requests.post(cfg.dapnet_url, data=dapnet_json, auth=HTTPBasicAuth(cfg.dapnet_user,cfg.dapnet_pass))
 
 # Construct the message to be sent
 def construct_message(c):
+    """Constructs a formatted message string for a transmission event.
+
+    This function generates a human-readable description of a radio transmission, including details about the source, destination, time, and duration. It provides a comprehensive text representation of a communication event.
+
+    Args:
+        c (dict): A dictionary containing transmission details with keys including:
+            - DestinationID
+            - Stop
+            - Start
+            - TalkerAlias
+            - SourceCall
+            - SourceName
+            - DestinationName
+
+    Returns:
+        str: A formatted message string describing the transmission event.
+    """
     tg = c["DestinationID"]
     out = ""
     duration = c["Stop"] - c["Start"]
@@ -141,9 +183,16 @@ def connect():
 
 @sio.on("mqtt")
 def on_mqtt(data):
-    if cfg.verbose and isinstance(data['payload'], dict) and data['payload'].get('DestinationID') in cfg.talkgroups:
-        logging.debug(f"Filtered MQTT event: Event={data['payload'].get('Event', 'Unknown')} DestinationID={data['payload'].get('DestinationID')} SourceCall={data['payload'].get('SourceCall')}")
+    """Processes MQTT messages from the Brandmeister network and manages notification logic.
+
+    This function handles incoming MQTT messages by evaluating communication events, tracking activity across talkgroups and callsigns, and triggering notifications based on configured criteria. It determines whether a communication event meets the notification requirements and dispatches messages through configured notification channels.
 
+    Args:
+        data (dict): A dictionary containing the MQTT payload with communication event details.
+
+    Returns:
+        None
+    """
     call = json.loads(data['payload'])
 
     tg = call["DestinationID"]

fly.toml

@@ -0,0 +1,20 @@
+# fly.toml app configuration file generated for bm-monitor on 2024-12-21T13:56:20-06:00
+#
+# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
+#
+
+app = 'bm-monitor'
+primary_region = 'dfw'
+
+[build]
+
+[http_service]
+  internal_port = 8080
+  force_https = true
+  auto_stop_machines = 'stop'
+  auto_start_machines = true
+  min_machines_running = 0
+  processes = ['app']
+
+[[vm]]
+  size = 'shared-cpu-1x'