logmachine 2.2.1__tar.gz → 2.3.1__tar.gz

{logmachine-2.2.1 → logmachine-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: logmachine
-Version: 2.2.1
+Version: 2.3.1
 Summary: Collaborative, beautiful logging system for distributed developers
 Author-email: Mugabo Gusenga <mugabo@bufferpunk.com>
 Project-URL: Homepage, https://logmachine.bufferpunk.com
@@ -80,10 +80,8 @@ To use your own central logging server, provide the configuration as shown below
 logger_config = {
     "url": "https://logmachine.bufferpunk.com",  # Base server URL
     "room": "team_alpha",                # Your organization or room
-    "endpoint": "/api/logs",             # Optional, defaults to /api/logs
-    "headers": {"Authorization": "Bearer token"},
-    "socketio": True,                    # Set False to use HTTP
-    "socketio_path": "/api/socket.io/"  # Optional
+    "endpoint": "/api/logs",             # Optional, defaults to /api/logs. Use /api/socket.io/ for Socket.IO transport.
+    "headers": {"Authorization": "Bearer token"}, # The central server should know your username based on the token you provide here. This is optional and depends on your central server's authentication mechanism.
 }
 logger = LogMachine("with_central", debug_level=0, central=logger_config, socketio=True)
 logger.success("Central logging is working!")
@@ -140,9 +138,12 @@ for entry in json_logs:
 
 ## 📡 Central Server Compatibility
 
-To use Socket.IO, your central server must support these events:
+To use Socket.IO, your central server must support this event:
 
 * `log`: Receives log payloads: `{ room: string, data: object }`
+
+For central username resolution, your server should expose an endpoint like:
+
 * `GET /api/get_username?base=localname`: Returns `{ "username": "..." }`
 
 ---
@@ -167,10 +168,8 @@ To use Socket.IO, your central server must support these events:
 | --------------- | ------ | -------------------------------------------------- |
 | `url`           | `str`  | Central server base URL                            |
 | `room`          | `str`  | Logical group or org name                          |
-| `endpoint`      | `str`  | HTTP endpoint for POST logs (default: `/api/logs`) |
+| `endpoint`      | `str`  | HTTP endpoint for POST logs (default: `/api/logs` or `/api/socket.io/` for Socket.IO) |
 | `headers`       | `dict` | Extra headers to send (e.g. auth token)            |
-| `socketio`      | `bool` | Whether to use Socket.IO instead of HTTP           |
-| `socketio_path` | `str`  | Path to socket.io on the server                    |
 
 ---
 

{logmachine-2.2.1 → logmachine-2.3.1}/README.md

@@ -62,10 +62,8 @@ To use your own central logging server, provide the configuration as shown below
 logger_config = {
     "url": "https://logmachine.bufferpunk.com",  # Base server URL
     "room": "team_alpha",                # Your organization or room
-    "endpoint": "/api/logs",             # Optional, defaults to /api/logs
-    "headers": {"Authorization": "Bearer token"},
-    "socketio": True,                    # Set False to use HTTP
-    "socketio_path": "/api/socket.io/"  # Optional
+    "endpoint": "/api/logs",             # Optional, defaults to /api/logs. Use /api/socket.io/ for Socket.IO transport.
+    "headers": {"Authorization": "Bearer token"}, # The central server should know your username based on the token you provide here. This is optional and depends on your central server's authentication mechanism.
 }
 logger = LogMachine("with_central", debug_level=0, central=logger_config, socketio=True)
 logger.success("Central logging is working!")
@@ -122,9 +120,12 @@ for entry in json_logs:
 
 ## 📡 Central Server Compatibility
 
-To use Socket.IO, your central server must support these events:
+To use Socket.IO, your central server must support this event:
 
 * `log`: Receives log payloads: `{ room: string, data: object }`
+
+For central username resolution, your server should expose an endpoint like:
+
 * `GET /api/get_username?base=localname`: Returns `{ "username": "..." }`
 
 ---
@@ -149,10 +150,8 @@ To use Socket.IO, your central server must support these events:
 | --------------- | ------ | -------------------------------------------------- |
 | `url`           | `str`  | Central server base URL                            |
 | `room`          | `str`  | Logical group or org name                          |
-| `endpoint`      | `str`  | HTTP endpoint for POST logs (default: `/api/logs`) |
+| `endpoint`      | `str`  | HTTP endpoint for POST logs (default: `/api/logs` or `/api/socket.io/` for Socket.IO) |
 | `headers`       | `dict` | Extra headers to send (e.g. auth token)            |
-| `socketio`      | `bool` | Whether to use Socket.IO instead of HTTP           |
-| `socketio_path` | `str`  | Path to socket.io on the server                    |
 
 ---
 

{logmachine-2.2.1 → logmachine-2.3.1}/logmachine/main.py

@@ -1,14 +1,27 @@
 import atexit
-import os
-import re
 import json
 import logging
-import requests
-import socketio
+import os
 import queue
+import re
+import requests
 from logging.handlers import QueueHandler, QueueListener
 
 
+"""
+We've removed the socketio and websockets dependency from the core of LogMachine to make it more lightweight and avoid forcing users to install it.
+The Logger will use socketio if available in the environment, otherwise it will fall back to HTTP requests for log transport.
+Socketio is generally more efficient for real-time log transport,
+while HTTP can be used as a fallback for environments where socketio is not available or not desired.
+Socketio takes precedence over HTTP if both are available, as it provides a more robust and efficient transport mechanism for real-time logging.
+"""
+
+try:
+    import socketio
+except ImportError:
+    pass
+
+
 def get_login():
     """
     Get the current user's login name.
@@ -40,6 +53,14 @@ class HTTPTransporter(logging.StreamHandler):
         super().__init__()
         self.parse_log = kwargs.get('log_parser')
         self.central = kwargs.get('central', None)
+        self.session = requests.Session()  # Use a session for connection pooling
+
+    def close(self):
+        try:
+            self.session.close()
+        except Exception:
+            pass
+        return super().close()
 
     def emit(self, record):
         try:
@@ -51,10 +72,10 @@ class HTTPTransporter(logging.StreamHandler):
 
             log_data = self.parse_log(msg)
             if log_data:
-                response = requests.post(
+                response = self.session.post(
                     f"{self.central.get('url', '') + self.central.get('endpoint', '/api/logs')}?room={self.central.get('room', '')}",
-                    json=log_data,
-                    headers={"Content-Type": "application/json", **self.central.get('headers', {})}
+                    json=log_data, timeout=(3, 3),
+                    headers={**self.central.get('headers', {}), 'Content-Type': 'application/json'}
                 )
                 if response.status_code != 200:
                     raise Exception(f"Failed to send log to central: {response.text}")
@@ -71,21 +92,34 @@ class SocketIOTransporter(logging.StreamHandler):
     def __init__(self, *args, **kwargs):
         super().__init__()
         self.parse_log = kwargs.get('log_parser')
-        self.central = kwargs.get('central', None)
+        self.central = kwargs.get('central', {})
         self.sio = socketio.Client()
-        if self.central:
-            self.sio.connect(self.central.get('url', ''), headers=self.central.get('headers', {}), socketio_path=self.central.get('socketio_path', '/api/socket.io/'))
+        if not self.central:
+            raise ValueError("""Central configuration must be provided for SocketIOTransporter.
+                Example: {'url': 'http://central-server.com/api/socket.io/', 'room': 'my_organization_name'}
+            """)
+        try:
+            self.sio.connect(self.central.get('url', ''), headers=self.central.get('headers', {}), socketio_path=self.central.get('endpoint', '/api/socket.io/'))
+        except Exception as e:
+            raise ConnectionError(f"Failed to connect to central server via SocketIO: {e}")
+
+    def close(self):
+        try:
+            if self.sio.connected:
+                self.sio.disconnect()
+        except Exception:
+            pass
+        return super().close()
 
     def emit(self, record):
         try:
             msg = self.format(record)
             super().emit(record)
-            if self.central:
+            if self.central and self.sio.connected:
                 if not self.central.get('room'):
-                    raise ValueError("""
-                                     Central configuration must include 'room' for log transport.
-                                        Example: {'url': 'http://central-server.com/api/logs', 'room': 'my_organization_name'}
-                                     """)
+                    raise ValueError("""Central configuration must include 'room' for log transport.
+                        Example: {'url': 'http://central-server.com/api/socket.io/', 'room': 'my_organization_name'}
+                    """)
 
                 log_data = self.parse_log(msg)
                 if log_data:
@@ -172,7 +206,8 @@ class LogMachine(logging.Logger):
             if not os.path.exists(os.path.expanduser("~/.cl_username")):
                 try:
                     login = get_login()
-                    response = requests.get(f"{self.central.get('url', '')}/api/get_username?base={login}")
+                    username_endpoint = self.central.get('get_username_endpoint', '/api/get_username')
+                    response = requests.get(f"{self.central.get('url', '')}/{username_endpoint}?base={login}", headers=self.central.get('headers', {}))
                     if response.status_code == 200:
                         os.environ['CL_USERNAME'] = response.json().get('username') or 'unknown' # Unknown will probably never be reached, but it's a fallback.
                         if os.environ.get('CL_USERNAME') != 'unknown':
@@ -185,7 +220,7 @@ class LogMachine(logging.Logger):
             else:
                 get_login()
 
-            if not kwargs.get('attached', False) and not self.central.get('socketio', False):
+            if 'socketio' not in globals():
                 ch = HTTPTransporter(log_parser=self.parse_log, central=self.central)
             else:
                 ch = SocketIOTransporter(log_parser=self.parse_log, central=self.central)

{logmachine-2.2.1 → logmachine-2.3.1}/logmachine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: logmachine
-Version: 2.2.1
+Version: 2.3.1
 Summary: Collaborative, beautiful logging system for distributed developers
 Author-email: Mugabo Gusenga <mugabo@bufferpunk.com>
 Project-URL: Homepage, https://logmachine.bufferpunk.com
@@ -80,10 +80,8 @@ To use your own central logging server, provide the configuration as shown below
 logger_config = {
     "url": "https://logmachine.bufferpunk.com",  # Base server URL
     "room": "team_alpha",                # Your organization or room
-    "endpoint": "/api/logs",             # Optional, defaults to /api/logs
-    "headers": {"Authorization": "Bearer token"},
-    "socketio": True,                    # Set False to use HTTP
-    "socketio_path": "/api/socket.io/"  # Optional
+    "endpoint": "/api/logs",             # Optional, defaults to /api/logs. Use /api/socket.io/ for Socket.IO transport.
+    "headers": {"Authorization": "Bearer token"}, # The central server should know your username based on the token you provide here. This is optional and depends on your central server's authentication mechanism.
 }
 logger = LogMachine("with_central", debug_level=0, central=logger_config, socketio=True)
 logger.success("Central logging is working!")
@@ -140,9 +138,12 @@ for entry in json_logs:
 
 ## 📡 Central Server Compatibility
 
-To use Socket.IO, your central server must support these events:
+To use Socket.IO, your central server must support this event:
 
 * `log`: Receives log payloads: `{ room: string, data: object }`
+
+For central username resolution, your server should expose an endpoint like:
+
 * `GET /api/get_username?base=localname`: Returns `{ "username": "..." }`
 
 ---
@@ -167,10 +168,8 @@ To use Socket.IO, your central server must support these events:
 | --------------- | ------ | -------------------------------------------------- |
 | `url`           | `str`  | Central server base URL                            |
 | `room`          | `str`  | Logical group or org name                          |
-| `endpoint`      | `str`  | HTTP endpoint for POST logs (default: `/api/logs`) |
+| `endpoint`      | `str`  | HTTP endpoint for POST logs (default: `/api/logs` or `/api/socket.io/` for Socket.IO) |
 | `headers`       | `dict` | Extra headers to send (e.g. auth token)            |
-| `socketio`      | `bool` | Whether to use Socket.IO instead of HTTP           |
-| `socketio_path` | `str`  | Path to socket.io on the server                    |
 
 ---
 

{logmachine-2.2.1 → logmachine-2.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "logmachine"
-version = "2.2.1"
+version = "2.3.1"
 description = "Collaborative, beautiful logging system for distributed developers"
 readme = "README.md"
 requires-python = ">=3.7"
@@ -22,5 +22,5 @@ Source = "https://github.com/logmachine/python"
 Tracker = "https://github.com/logmachine/python/issues"
 
 [build-system]
-requires = ["setuptools>=61.0", "websocket-client", "python-socketio", "requests"]
+requires = ["setuptools>=61.0", "requests"]
 build-backend = "setuptools.build_meta"