bedger 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

bedger/edge/entities/severity.py

@@ -7,3 +7,4 @@ class Severity(str, Enum):
     MEDIUM = "MEDIUM"
     HIGH = "HIGH"
     CRITICAL = "CRITICAL"
+    INFO = "INFO"

bedger-0.0.5.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: bedger
+Version: 0.0.5
+Summary: Edge monitoring software for secure and efficient device management.
+Author: Henk van den Brink
+Author-email: henk.vandenbrink@bedger.io
+Requires-Python: >=3.8.1,<4.0.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pydantic (>=2.9.2,<3.0.0)
+Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
+Project-URL: homepage, https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk
+Project-URL: issues, https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk/issues
+Description-Content-Type: text/markdown
+
+# ConnectionManager Class Documentation
+
+The `ConnectionManager` class manages connections to a UNIX socket for sending and receiving messages.
+It provides context management capabilities to ensure connections are properly opened and closed.
+
+## Features
+- Context manager support for connection lifecycle management.
+- Error handling for socket-related issues.
+- Sends event messages with acknowledgment handling.
+
+## Installation
+Ensure you have the `bedger` package and its dependencies installed.
+
+```bash
+pip install bedger
+```
+
+## Usage
+The following example demonstrates how to use the `ConnectionManager` to send events:
+
+```python
+import time
+import bedger.edge.config as config
+import bedger.edge.connection as connection
+import bedger.edge.entities as entities
+
+if __name__ == "__main__":
+    events = [
+        {"event_type": "EventA", "severity": entities.Severity.HIGH, "payload": {"key": "value1"}},
+        {"event_type": "EventB", "severity": entities.Severity.LOW, "payload": {"key": "value2"}},
+        {"event_type": "EventC", "severity": entities.Severity.CRITICAL, "payload": {"key": "value3"}},
+    ]
+
+    with connection.ConnectionManager(config.Config()) as conn:
+        for event in events:
+            time.sleep(1)
+            conn.send_event(event["event_type"], event["severity"], event["payload"])
+```
+
+## API Reference
+
+### `ConnectionManager`
+Manages a connection to a UNIX socket for sending and receiving messages.
+
+#### Constructor
+- **`__init__(config: Config = Config())`**
+  - Initializes the `ConnectionManager` with a specified configuration.
+  - **Parameters:**
+    - `config (Config)`: The configuration containing the socket path. Defaults to a new `Config` instance.
+
+#### Context Management
+- **`__enter__() -> ConnectionManager`**
+  - Establishes the socket connection when entering the context.
+  - **Returns:** The instance of the `ConnectionManager`.
+
+- **`__exit__(exc_type, exc_value, traceback) -> None`**
+  - Closes the socket connection when exiting the context.
+
+#### Methods
+- **`send_event(event_type: str, severity: str | Severity, payload: dict) -> None`**
+  - Sends an event message through the socket.
+  - **Parameters:**
+    - `event_type (str)`: The type of event being sent.
+    - `severity (str | Severity)`: The severity level of the event.
+    - `payload (dict)`: The event's payload details.
+  - **Raises:**
+    - `SocketNotConnectedError`: If no active socket connection exists.
+    - `SocketBrokenPipeError`: If the socket connection is lost during transmission.
+    - `SocketCommunicationError`: If an error occurs during socket communication.
+
+## Error Handling
+The `ConnectionManager` raises custom errors from the `bedger.edge.errors` module for:
+- Permission issues (`SocketPermissionDeniedError`).
+- Missing socket files (`SocketFileNotFoundError`).
+- Connection problems (`SocketConnectionError`).
+- Communication errors (`SocketCommunicationError`, `SocketBrokenPipeError`).
+
+## Logging
+The class uses the `logging` module to log the following:
+- Connection attempts and successes.
+- Errors during connection, disconnection, and message sending.
+- Debug information for message preparation and acknowledgments.
+
+## License
+This project is licensed under the MIT License. See the LICENSE file for details.
+

{bedger-0.0.3.dist-info → bedger-0.0.5.dist-info}/RECORD

@@ -4,9 +4,9 @@ bedger/edge/config.py,sha256=0fUKThP0aJFk3WBF7JUtuKKhXlV07SX5VnqVOLNou-A,152
 bedger/edge/connection.py,sha256=25h7PzRhSw8m0w679p23M6X_o-wuIOl7M1P837bpy9I,5400
 bedger/edge/entities/__init__.py,sha256=_oKO_XdDerqOwVX8izhDPtGv4HqVDwQaT-otOdY8lYg,91
 bedger/edge/entities/message.py,sha256=wLbEZik_FBboyEAvX5Uvlto1t4BsjaeLXUFGOIjIHRU,913
-bedger/edge/entities/severity.py,sha256=tUN7eDSEN5cc5eAqhvKzVHD1pSEmrdwvNEGsmh4Pnfw,157
+bedger/edge/entities/severity.py,sha256=lzJhqjFfeJ26EWJYDIe-Fotml00dQK6_ihpc_0NzLRg,175
 bedger/edge/errors.py,sha256=6jdmhlKoWlD-kZ8-xRiAlObRHEo9PwrKqhWQ5su5TLk,266
-bedger-0.0.3.dist-info/LICENSE,sha256=lVrf6pfElYZ_o6ETq-XR91_7GHTzKGyeNWAKghvcNUE,1075
-bedger-0.0.3.dist-info/METADATA,sha256=md3fa-i_3zHQEN84mDwBea3-QgJ0xxtXnnHkR8P8X88,859
-bedger-0.0.3.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-bedger-0.0.3.dist-info/RECORD,,
+bedger-0.0.5.dist-info/LICENSE,sha256=lVrf6pfElYZ_o6ETq-XR91_7GHTzKGyeNWAKghvcNUE,1075
+bedger-0.0.5.dist-info/METADATA,sha256=-yEloT1oseSC-2g89JZtO07GDqW5mH1RkbribcyN6hk,4144
+bedger-0.0.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+bedger-0.0.5.dist-info/RECORD,,

bedger-0.0.3.dist-info/METADATA

@@ -1,20 +0,0 @@
-Metadata-Version: 2.1
-Name: bedger
-Version: 0.0.3
-Summary: Edge monitoring software for secure and efficient device management.
-Author: Henk van den Brink
-Author-email: henk.vandenbrink@bedger.io
-Requires-Python: >=3.8.1,<4.0.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: pydantic (>=2.9.2,<3.0.0)
-Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
-Project-URL: homepage, https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk
-Project-URL: issues, https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk/issues
-Description-Content-Type: text/markdown
-
-