odysseus 0.1.1__tar.gz

odysseus-0.1.1/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.
+

odysseus-0.1.1/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.2
+Name: odysseus
+Version: 0.1.1
+Summary: A client for CodeTitans Odysseus Logging Platform.
+Author-email: Paweł Hofman <pawel@codetitans.pl>
+License: Copyright (c) 2018 The Python Packaging Authority
+        
+        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/codetitans/odysseus-py
+Project-URL: Issues, https://github.com/codetitans/odysseus-py/issues
+Keywords: logs,logging,Odysseus
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.32.3
+Requires-Dist: tzlocal<6.0,>=5.2
+
+# Odysseus Platform - Python client
+
+This repository contains full source code of the simple Python project capable of uploading log entries or events happening on a backend application - back to the [Odysseus Logging Platform](https://odysseus.codetitans.dev).
+
+Once it's added as a dependency of your Python application, it has to be connected with your existing logging system and logs serialization has to be redirected to be able to process them and pass back to the server.
+
+## Disclaimer
+
+Full utilization of the Odysseus Logging Platform services is subject to the proper contract and not part of that client functionality. By using this software you essentially agree that since it's an open-source project you read it and understand all repercussions of using it. Thus you will never claim or call for any compensations or damages in connection with downtime of your own services caused by this software.
+
+## Build
+
+To create the new bundled release simply call following command:
+
+```shell
+$ ./build.sh package
+```
+
+What it does internally, is only performs several checks around missing environmental setup and calls the build command:
+
+```shell
+$ python3 -m build
+```
+
+-----
+CodeTitans Sp. z o.o. (2025-)

odysseus-0.1.1/README.md

@@ -0,0 +1,26 @@
+# Odysseus Platform - Python client
+
+This repository contains full source code of the simple Python project capable of uploading log entries or events happening on a backend application - back to the [Odysseus Logging Platform](https://odysseus.codetitans.dev).
+
+Once it's added as a dependency of your Python application, it has to be connected with your existing logging system and logs serialization has to be redirected to be able to process them and pass back to the server.
+
+## Disclaimer
+
+Full utilization of the Odysseus Logging Platform services is subject to the proper contract and not part of that client functionality. By using this software you essentially agree that since it's an open-source project you read it and understand all repercussions of using it. Thus you will never claim or call for any compensations or damages in connection with downtime of your own services caused by this software.
+
+## Build
+
+To create the new bundled release simply call following command:
+
+```shell
+$ ./build.sh package
+```
+
+What it does internally, is only performs several checks around missing environmental setup and calls the build command:
+
+```shell
+$ python3 -m build
+```
+
+-----
+CodeTitans Sp. z o.o. (2025-)

odysseus-0.1.1/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "odysseus"
+version = "0.1.1"
+authors = [
+  { name="Paweł Hofman", email="pawel@codetitans.pl" },
+]
+description = "A client for CodeTitans Odysseus Logging Platform."
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = { file="LICENSE" }
+keywords = ["logs", "logging", "Odysseus"]
+dependencies = [
+  "requests >= 2.32.3, < 3.0",
+  "tzlocal >= 5.2, < 6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/codetitans/odysseus-py"
+Issues = "https://github.com/codetitans/odysseus-py/issues"

odysseus-0.1.1/setup.cfg

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

odysseus-0.1.1/src/odysseus/odysseus.py

@@ -0,0 +1,196 @@
+import datetime
+import requests
+import urllib.parse
+
+from threading import Lock, Timer
+from typing import Optional, Any, TypeVar, Generic, Dict
+from tzlocal import get_localzone
+from uuid import uuid4, UUID
+
+########################################################################################################################
+log_silent = False
+log_tag = 'Odysseus'
+
+def internal_log(message: str):
+    if log_silent:
+        return
+    ts = datetime.datetime.now(tz=get_localzone())
+    time = "{:02d}:{:02d}:{:02d}".format(ts.hour, ts.minute, ts.second)
+    print(f"[{time}] [INFO] {log_tag}: {message}")
+
+
+class OdysseusLog:
+
+    def __init__(self, message: str, session_id: UUID,
+                 severity: int = 0, tag: Optional[str] = None,
+                 file: Optional[str] = None, line: Optional[int] = None,
+                 user: Optional[str] = None, timestamp: Optional[datetime.datetime] = None,
+                 context: Optional[Dict[str, Any]] = None):
+
+        self.session_id = session_id.hex
+        self.message = message
+        self.severity = severity
+        self.tag = tag
+        self.timestamp = datetime.datetime.now(tz=get_localzone()).isoformat() if timestamp is None else timestamp.isoformat()
+        self.file = file
+        self.line = line
+        self.user = user
+        self.context = context
+
+
+class OdysseusEvent:
+
+    def __init__(self, id: UUID, name: str, session_id: UUID, type: int = 0, stream_id: Optional[UUID] = None, position: int = 0,
+                 user: Optional[str] = None, timestamp: Optional[datetime.datetime] = None,
+                 data: Optional[Dict[str, Any]] = None, meta: Optional[Dict[str, Any]] = None):
+
+        self.id = id.hex
+        self.session_id = session_id.hex
+        self.name = name
+        self.type = type
+        self.timestamp = datetime.datetime.now(tz=get_localzone()).isoformat() if timestamp is None else timestamp.isoformat()
+        self.stream_id = uuid4().hex if stream_id is None else stream_id.hex
+        self.position = position
+        self.user = user
+        self.data = data
+        self.meta = meta
+
+
+T = TypeVar('T')
+
+class OdysseusCollection(Generic[T]):
+
+    def __init__(self, endpoint: str, entity_name: str, delay: int = 5):
+        self.entries: [T] = []
+        self.to_upload: [T] = []
+        self.endpoint = endpoint
+        self.entity_name = entity_name
+        self.delay = delay
+        self.timer = None
+        self.lock = Lock()
+
+    def add(self, item: T):
+        with self.lock:
+            self.entries.append(item)
+
+            if self.timer is None:
+                self.timer = Timer(self.delay, self.execute_upload)
+                self.timer.start()
+
+    def execute_upload(self):
+
+        # copy the entries aside and try to upload them
+        with self.lock:
+            self.to_upload = self.entries
+            self.entries = []
+
+        success = False
+        try:
+            success = self.upload_entries(self.to_upload)
+            if success:
+                # once upload finished successfully, clear all temporary data
+                with self.lock:
+                    self.to_upload = []
+                    self.timer = None
+        except Exception as e:
+            internal_log(f"Failed to upload {self.entity_name} to Odysseus: {e}")
+
+        if not success or len(self.entries) > 0:
+            with self.lock:
+                self.to_upload.extend(self.entries)
+                self.entries = []
+
+                # restart the timer
+                self.timer = Timer(self.delay, self.execute_upload)
+                self.timer.start()
+
+    def upload_entries(self, data: [T]) -> bool:
+        url = "https://odysseus.codetitans.dev" + self.endpoint
+        # url = "http://192.168.2.183:5757" + self.endpoint
+        response = requests.post(url, json=[x.__dict__ for x in data])
+
+        global log_silent
+        if 200 <= response.status_code < 300:
+            if not log_silent:
+                text = response.text
+                internal_log(f"Successfully uploaded {self.entity_name} to Odysseus: {response.status_code} (\"{text}\")")
+            return True
+        else:
+            if not log_silent:
+                text = response.text
+                internal_log(f"Failed to upload {self.entity_name} to Odysseus: {response.status_code} ({text})")
+            return False
+
+
+class OdysseusClient:
+
+    def __init__(self, app_id: str, app_key: str, user: Optional[str] = None, session: Optional[UUID] = None,
+                 min_severity: int = 1, silent: bool = False):
+        global log_silent
+        log_silent = silent
+
+        self.user_id = user
+        self.session_id = uuid4() if session is None else session
+        self.min_severity_level = min_severity
+        self.app_id = app_id
+        self.app_key = app_key
+        self.logs = OdysseusCollection[OdysseusLog](endpoint="/api/logs" + urllib.parse.quote('/' + app_id + '/' + app_key), delay=5, entity_name="logs")
+        self.events = OdysseusCollection[OdysseusEvent](endpoint="/api/events" + urllib.parse.quote('/' + app_id + '/' + app_key), delay=5, entity_name="events")
+
+        internal_log(f"Initialised for application: \"{self.app_id}\" (session: \"{self.session_id.hex}\", delay: {self.logs.delay}s)")
+
+    @property
+    def user(self) -> Optional[str]:
+        return self.user_id
+
+    @user.setter
+    def user(self, value: Optional[str] = None):
+        self.user_id = value
+
+    @property
+    def session(self) -> UUID:
+        return self.session_id
+
+    @session.setter
+    def session(self, value: UUID):
+        self.session_id = value
+
+    @property
+    def min_severity(self) -> int:
+        return self.min_severity_level
+
+    @min_severity.setter
+    def min_severity(self, value: int):
+        self.min_severity_level = value
+
+    def log(self, message: str, severity: int, tag: Optional[str] = None,
+            file: Optional[str] = None, line: Optional[int] = None, timestamp: Optional[datetime.datetime] = None,
+            context: Optional[Dict[str, Any]] = None) -> Optional[OdysseusLog]:
+        if severity < self.min_severity_level:
+            return None
+
+        return self.add_log(OdysseusLog(message, self.session_id, severity=severity, tag=tag,
+                                        user=self.user_id, timestamp=timestamp, file=file, line=line, context=context))
+
+    def add_log(self, entry: OdysseusLog) -> Optional[OdysseusLog]:
+        if entry.severity < self.min_severity_level:
+            return None
+
+        self.logs.add(entry)
+        return entry
+
+    def event(self, name: str, id: Optional[UUID] = None, type: int = 0, stream_id: Optional[UUID] = None, position: Optional[int] = None,
+              timestamp: Optional[datetime.datetime] = None,
+              data: Optional[Dict[str, Any]] = None, meta: Optional[Dict[str, Any]] = None) -> OdysseusEvent:
+        return self.add_event(OdysseusEvent(
+            uuid4() if id is None else id,
+            name=name, session_id=self.session_id, type=type, stream_id=stream_id, position=position,
+            user=self.user, timestamp=timestamp, data=data, meta=meta))
+
+    def add_event(self, event: OdysseusEvent) -> OdysseusEvent:
+        self.events.add(event)
+        return event
+
+
+
+

odysseus-0.1.1/src/odysseus.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.2
+Name: odysseus
+Version: 0.1.1
+Summary: A client for CodeTitans Odysseus Logging Platform.
+Author-email: Paweł Hofman <pawel@codetitans.pl>
+License: Copyright (c) 2018 The Python Packaging Authority
+        
+        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/codetitans/odysseus-py
+Project-URL: Issues, https://github.com/codetitans/odysseus-py/issues
+Keywords: logs,logging,Odysseus
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.32.3
+Requires-Dist: tzlocal<6.0,>=5.2
+
+# Odysseus Platform - Python client
+
+This repository contains full source code of the simple Python project capable of uploading log entries or events happening on a backend application - back to the [Odysseus Logging Platform](https://odysseus.codetitans.dev).
+
+Once it's added as a dependency of your Python application, it has to be connected with your existing logging system and logs serialization has to be redirected to be able to process them and pass back to the server.
+
+## Disclaimer
+
+Full utilization of the Odysseus Logging Platform services is subject to the proper contract and not part of that client functionality. By using this software you essentially agree that since it's an open-source project you read it and understand all repercussions of using it. Thus you will never claim or call for any compensations or damages in connection with downtime of your own services caused by this software.
+
+## Build
+
+To create the new bundled release simply call following command:
+
+```shell
+$ ./build.sh package
+```
+
+What it does internally, is only performs several checks around missing environmental setup and calls the build command:
+
+```shell
+$ python3 -m build
+```
+
+-----
+CodeTitans Sp. z o.o. (2025-)

odysseus-0.1.1/src/odysseus.egg-info/SOURCES.txt

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

odysseus-0.1.1/src/odysseus.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

odysseus-0.1.1/src/odysseus.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests<3.0,>=2.32.3
+tzlocal<6.0,>=5.2

odysseus-0.1.1/src/odysseus.egg-info/top_level.txt

@@ -0,0 +1 @@
+odysseus