ol-datastar 0.0.1__tar.gz

ol-datastar-0.0.1/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: ol-datastar
+Version: 0.0.1
+Summary: Helpful utilities for working with Datastar projects
+Home-page: https://cosmicfrog.com
+Author: Optilogic
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: sqlalchemy>=2.0.27
+Requires-Dist: optilogic>=2.13.0
+Requires-Dist: PyJWT>=2.8.0
+Requires-Dist: httpx>=0.24.1
+Requires-Dist: psycopg2-binary>=2.9.9

ol-datastar-0.0.1/ol-datastar/__init__.py

@@ -0,0 +1 @@
+from .datastar import Datastar

ol-datastar-0.0.1/ol-datastar/datastar.py

@@ -0,0 +1,74 @@
+"""
+    Helper functions for working with Datastar projects
+"""
+
+import os
+import sys
+from typing import Dict, List, Optional, Tuple, Any
+from .frog_platform import OptilogicClient
+
+# pylint: disable=logging-fstring-interpolation
+
+DSTAR_IDLE_TRANSACTION_TIMEOUT = os.getenv("DSTAR_IDLE_TRANSACTION_TIMEOUT", 1800)
+ATLAS_API_BASE_URL = os.getenv("ATLAS_API_BASE_URL", "https://api.optilogic.app/v0")
+
+class Datastar:
+    """
+    Datastar class with helper functions for accessing Datastar projects
+    """
+
+    # This allows app key to be set once for all instances, makes utilities easier to write
+    class_app_key = None
+
+    # Helper method for setting up app key
+    @classmethod
+    def __set_app_key__(
+        cls,
+        app_key: Optional[str],
+        raise_if_not_found: Optional[bool] = True
+    ) -> str:
+        """
+        Helper method for setting up app key.
+
+        There are 4 ways to set the app key:
+        1) Passed in argument when opening a model e.g. FrogModel(app_key="my_app_key", model_name="my_model")
+        2) Set via class variable (used for all instances of FrogModel, used in utilities)
+        3) Via Enviroment var, in Andromeda (if running in Andromeda)
+        4) Via app.key file (when running locally, place file in folder with your script)
+
+        Args:
+            app_key: Optional app key
+
+        Returns:
+            App key
+        
+        """
+        try:
+            found_app_key = app_key or cls.class_app_key or os.environ.get("OPTILOGIC_JOB_APPKEY")
+
+            if not found_app_key:
+                initial_script_dir = os.path.dirname(os.path.realpath(sys.argv[0]))
+                file_path = os.path.join(initial_script_dir, "app.key")
+                if os.path.exists(file_path):
+                    with open(file_path, "r", encoding="utf-8") as file:
+                        found_app_key = file.read().strip()
+
+            if not found_app_key and raise_if_not_found:
+                raise ValueError("App key not found. Please provide a valid app key.")
+
+            return found_app_key
+        except Exception as e:
+            # cls.log.exception(f"Error setting app key: {e}", exc_info=True)
+            raise ValueError(f"Error setting app key: {e}")
+
+    def __init__(
+        self,
+        project_name: Optional[str] = None,
+        connection_string: Optional[str] = None,
+        application_name: str = "Datastar User Library",
+        app_key: Optional[str] = None
+    ) -> None:
+        pass
+
+
+    

ol-datastar-0.0.1/ol-datastar/frog_platform.py

@@ -0,0 +1,107 @@
+"""
+Functions to facilitate interactions with Optilogic platform using 'optilogic' library
+"""
+
+import os
+import json
+import logging
+import time
+from typing import Tuple
+import optilogic
+
+
+class OptilogicClient:
+    """
+    Wrapper for optilogic module for consumption in Cosmic Frog services
+    """
+
+    def __init__(self, username=None, appkey=None, logger=logging.getLogger()):
+        # Detect if being run in Andromeda
+        job_app_key = os.environ.get("OPTILOGIC_JOB_APPKEY")
+
+        if appkey and not username:
+            # Use supplied key
+            self.api = optilogic.pioneer.Api(auth_legacy=False, appkey=appkey)
+        elif appkey and username:
+            # Use supplied key & name
+            self.api = optilogic.pioneer.Api(auth_legacy=False, appkey=appkey, un=username)
+        elif job_app_key:
+            # Running on Andromeda
+            self.api = optilogic.pioneer.Api(auth_legacy=False)
+        else:
+            raise ValueError("OptilogicClient could not authenticate")
+
+        self.logger = logger
+
+    def model_exists(self, model_name: str) -> bool:
+        """
+        Returns True if a given model exists, False otherwise
+        """
+        try:
+            return self.api.storagename_database_exists(model_name)
+        except Exception as e:  # pylint: disable=broad-exception-caught
+            self.logger.error(f"Exception in cosmicfrog: {e}")
+            return False
+
+    def get_connection_string(self, model_name: str) -> Tuple[bool, str]:
+
+        # TODO: There are two connection string fetch functions, see also frog_dbtools
+
+        try:
+            rv = {"message": "error getting connection string"}
+            if not self.api.storagename_database_exists(model_name):
+                return False, ""
+
+            connection_info = self.api.sql_connection_info(model_name)
+
+            return True, connection_info["connectionStrings"]["url"]
+
+        except Exception as e:
+            self.logger.error(f"Exception in cosmicfrog: {e}")
+            return False, ""
+
+    def create_model_synchronous(self, model_name: str, model_template: str):
+        try:
+            new_model = self.api.database_create(name=model_name, template=model_template)
+
+            status = "success"
+            rv = {}
+            if "crash" in new_model:
+                status = "error"
+                rv["message"] = json.loads(new_model["response_body"])["message"]
+                rv["httpStatus"] = new_model["resp"].status_code
+            else:
+                while not self.api.storagename_database_exists(model_name):
+                    self.logger.info(f"creating {model_name}")
+                    time.sleep(3.0)
+                connections = self.api.sql_connection_info(model_name)
+                rv["model"] = new_model
+                rv["connection"] = connections
+
+            return status, rv
+
+        except Exception as e:
+            return "exception", e
+
+
+    def delete_model_api(self, model_name: str) -> dict:
+        """
+        Delete a model from the platform
+
+        Args:
+            model_name (str): Name of the model to delete
+        
+        Returns:
+            dict: Status of the operation
+        """
+        if not model_name:
+            return {"status": "error", "message": "Model name is required"}
+
+        try:
+            response = self.api.storage_delete(name=model_name)
+            if response.get('result', 'error') == 'error':
+                    return {"status": "error", "message": response.get('message', '')}
+
+            return {"status": "success", "message": f"Model {model_name} deleted successfully"}
+        except Exception as e:
+            return {"status": "error", "message": str(e)}

ol-datastar-0.0.1/ol_datastar.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: ol-datastar
+Version: 0.0.1
+Summary: Helpful utilities for working with Datastar projects
+Home-page: https://cosmicfrog.com
+Author: Optilogic
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: sqlalchemy>=2.0.27
+Requires-Dist: optilogic>=2.13.0
+Requires-Dist: PyJWT>=2.8.0
+Requires-Dist: httpx>=0.24.1
+Requires-Dist: psycopg2-binary>=2.9.9

ol-datastar-0.0.1/ol_datastar.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+setup.py
+ol-datastar/__init__.py
+ol-datastar/datastar.py
+ol-datastar/frog_platform.py
+ol_datastar.egg-info/PKG-INFO
+ol_datastar.egg-info/SOURCES.txt
+ol_datastar.egg-info/dependency_links.txt
+ol_datastar.egg-info/requires.txt
+ol_datastar.egg-info/top_level.txt

ol-datastar-0.0.1/ol_datastar.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ol-datastar-0.0.1/ol_datastar.egg-info/requires.txt

@@ -0,0 +1,7 @@
+numpy>=1.26.4
+pandas>=2.1.0
+sqlalchemy>=2.0.27
+optilogic>=2.13.0
+PyJWT>=2.8.0
+httpx>=0.24.1
+psycopg2-binary>=2.9.9

ol-datastar-0.0.1/ol_datastar.egg-info/top_level.txt

@@ -0,0 +1 @@
+ol-datastar

ol-datastar-0.0.1/setup.cfg

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

ol-datastar-0.0.1/setup.py

@@ -0,0 +1,53 @@
+"""
+    Library setup file
+"""
+import subprocess
+from setuptools import setup
+
+
+try:
+    subprocess.check_output(['pip', 'show', 'psycopg2'])
+    PSYCOPG2_INSTALLED = True
+except subprocess.CalledProcessError:
+    PSYCOPG2_INSTALLED = False
+
+
+install_requires = [
+    "numpy>=1.26.4",
+    "pandas>=2.1.0",
+    "sqlalchemy>=2.0.27",
+    "optilogic>=2.13.0",
+    "PyJWT>=2.8.0",
+    "httpx>=0.24.1"
+]
+
+# If psycopg2 is not installed let's check if we should use the binary version instead
+if not PSYCOPG2_INSTALLED:
+    import os
+
+    # Look for USE_PSYCOPG2_BINARY, if not set, default to True, otherwise, use the value
+    USE_BINARY = os.getenv('USE_PSYCOPG2_BINARY', 'True').lower() == 'true'
+
+    if USE_BINARY:
+        install_requires.append('psycopg2-binary>=2.9.9')
+    else:
+        install_requires.append('psycopg2>=2.9.9')
+
+
+setup(
+    name="ol-datastar",
+    include_package_data=True,
+    version="0.0.1",
+    description="Helpful utilities for working with Datastar projects",
+    url="https://cosmicfrog.com",
+    author="Optilogic",
+    packages=["ol-datastar"],
+    license="MIT",
+    install_requires=install_requires,
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.11",
+)