bfabric-web-apps 0.1.0__tar.gz

bfabric-web-apps-0.1.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: bfabric-web-apps
+Version: 0.1.0
+Summary: A package containing handy boilerplate utilities for developing bfabric web-applications
+Author: Mark Zuber, Griffin White, GWC GmbH
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9

bfabric-web-apps-0.1.0/bfabric_web_apps/__init__.py

@@ -0,0 +1,6 @@
+from objects import (
+    BfabricInterface,
+    Logger
+)
+
+from layouts.layouts import *

bfabric-web-apps-0.1.0/bfabric_web_apps/layouts/layouts.py

@@ -0,0 +1,13 @@
+
+
+def get_empty_layout(): 
+
+    pass 
+
+def get_layout_with_sidebar(): 
+    
+    pass 
+
+def get_layout_without_sidebar(): 
+    
+    pass

bfabric-web-apps-0.1.0/bfabric_web_apps/objects/BfabricInterface.py

@@ -0,0 +1,16 @@
+from bfabric import Bfabric 
+
+class BfabricInterface( Bfabric ): 
+
+    def __init__(): 
+        pass
+
+    def token_to_data(self, token): 
+        pass
+
+    def token_response_to_bfabric(self, token_response): 
+        pass
+
+    def entity_data(self, entity): 
+        pass
+

bfabric-web-apps-0.1.0/bfabric_web_apps/objects/Logger.py

@@ -0,0 +1,99 @@
+import os
+import pickle
+from bfabric import Bfabric
+from datetime import datetime as dt
+import base64
+
+try:
+    from PARAMS import CONFIG_FILE_PATH
+except ImportError:
+    CONFIG_FILE_PATH = "~/.bfabricpy.yml"
+
+
+class Logger:
+    """
+    A Logger class to manage and batch API call logs locally and flush them to the backend when needed.
+    """
+    def __init__(self, jobid: int, username: str):
+        self.jobid = jobid
+        self.username = username
+        self.power_user_wrapper = self._get_power_user_wrapper()
+        self.logs = []
+
+    def _get_power_user_wrapper(self) -> Bfabric:
+        """
+        Initializes a B-Fabric wrapper using the power user's credentials.
+        """
+        power_user_wrapper = Bfabric.from_config(
+            config_path=os.path.expanduser(CONFIG_FILE_PATH)
+        )
+        return power_user_wrapper
+
+    def to_pickle(self):
+        # Pickle the object and then encode it as a base64 string
+        return {"data": base64.b64encode(pickle.dumps(self)).decode('utf-8')}
+
+    @classmethod 
+    def from_pickle(cls, pickle_object):
+        # Decode the base64 string back to bytes and then unpickle
+        return pickle.loads(base64.b64decode(pickle_object.get("data").encode('utf-8')))
+
+    def log_operation(self, operation: str, message: str, params = None, flush_logs: bool = True):
+        """
+        Log an operation either locally (if flush_logs=False) or flush to the backend.
+        Creates well-structured, readable log entries.
+        """
+        # Define the timestamp format
+        timestamp = dt.now().strftime('%Y-%m-%d %H:%M:%S')
+
+        # Build the base log entry
+        log_entry = (
+            f"[{timestamp}] "      
+            f"USER: {self.username} | "
+            f"OPERATION: {operation.upper()} | "
+            f"MESSAGE: {message}"
+        )
+
+        # Add parameters if provided
+        if params is not None:
+            log_entry += f" | PARAMETERS: {params}"
+
+        # Flush or store the log entry
+        if flush_logs:
+            self.logs.append(log_entry)  # Temporarily append for flushing
+            self.flush_logs()  # Flush all logs, including the new one
+        else:
+            self.logs.append(log_entry)  # Append to local logs
+
+
+
+    def flush_logs(self):
+        """
+        Send all accumulated logs for this job to the backend and clear the local cache.
+        """
+        if not self.logs:
+            return  # No logs to flush
+
+        try:
+            full_log_message = "\n".join(self.logs)
+            self.power_user_wrapper.save("job", {"id": self.jobid, "logthis": full_log_message})
+            self.logs = []  # Clear logs after successful flush
+        except Exception as e:
+            print(f"Failed to save log to B-Fabric: {e}")
+
+    def logthis(self, api_call: callable, *args, params=None , flush_logs: bool = True, **kwargs) -> any:
+        """
+        Generic logging function to wrap any API call using a Logger instance.
+        """
+        # Construct a message describing the API call
+        call_args = ', '.join([repr(arg) for arg in args])
+        call_kwargs = ', '.join([f"{key}={repr(value)}" for key, value in kwargs.items()])
+        log_message = f"{api_call.__name__}({call_args}, {call_kwargs})"
+
+        # Execute the actual API call
+        result = api_call(*args, **kwargs)
+
+        # Log the operation
+        self.log_operation(api_call.__name__, log_message, params, flush_logs=flush_logs)
+
+        return result

bfabric-web-apps-0.1.0/pyproject.toml

@@ -0,0 +1,14 @@
+[tool.poetry]
+name = "bfabric-web-apps"
+version = "0.1.0"
+description = "A package containing handy boilerplate utilities for developing bfabric web-applications"
+authors = ["Mark Zuber, Griffin White, GWC GmbH"]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

bfabric-web-apps-0.1.0/setup.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['bfabric_web_apps', 'bfabric_web_apps.layouts', 'bfabric_web_apps.objects']
+
+package_data = \
+{'': ['*']}
+
+setup_kwargs = {
+    'name': 'bfabric-web-apps',
+    'version': '0.1.0',
+    'description': 'A package containing handy boilerplate utilities for developing bfabric web-applications',
+    'long_description': None,
+    'author': 'Mark Zuber, Griffin White, GWC GmbH',
+    'author_email': None,
+    'maintainer': None,
+    'maintainer_email': None,
+    'url': None,
+    'packages': packages,
+    'package_data': package_data,
+    'python_requires': '>=3.8,<4.0',
+}
+
+
+setup(**setup_kwargs)