prisma-api 0.3.0__py3-none-any.whl

prisma_api/__init__.py

@@ -0,0 +1,6 @@
+__version__ = "0.3.0"
+
+
+from prisma_api.prisma_api import prisma_api as init        # Main prisma_api class for initialisation
+from prisma_api.prisma_api_v2 import PrismaAPIv2             # v2 API client (also accessible as api.v2)
+from prisma_api.config import update_dev_mode, update_dev_host_port, locate_config  # Config utility functions

prisma_api/config.py

@@ -0,0 +1,182 @@
+from pathlib import Path
+import pandas as pd
+import yaml
+import platformdirs
+
+
+
+### Helper functions for config management
+
+# Internal function to get user config directory
+def _user_config_dir() -> Path:
+    """Return cross-platform user config directory Path."""
+    if platformdirs is not None:
+        return Path(platformdirs.user_config_dir("prisma_api", "prisma-api"))
+    return Path.home() / ".prisma_api"
+
+# Internal function to get path to config.yaml
+def get_config_path() -> Path:
+    """Get the path to the config.yaml file (ensuring parent exists)."""
+    cfg_dir = _user_config_dir()
+    cfg_dir.mkdir(parents=True, exist_ok=True)
+    return cfg_dir / "config.yaml"
+
+# Public function to get config.yaml path as string
+def locate_config() -> str:
+    """Return the config.yaml path as a string (ensuring parent exists)."""
+    return str(get_config_path())
+
+# Internal function to load config from config.yaml
+def load_config():
+    """Load configuration from config.yaml if it exists; return dict or None."""
+    cfg_file = get_config_path()
+    if not cfg_file.exists():
+        return None
+    if yaml is None:
+        raise ImportError("PyYAML is required. Install with: pip install pyyaml")
+    with open(cfg_file, "r") as f:
+        cfg = yaml.safe_load(f) or {}
+
+    return cfg
+
+# Internal function to create config.yaml
+def create_config_file(api_key: str = None):
+    """
+    Create config.yaml. If api_key is None, prompt via CLI.
+
+    Args:
+        api_key: PrISMa API key.
+
+    Returns:
+        dict: The config that was written.
+    """
+    if yaml is None:
+        raise ImportError("PyYAML is required. Install with: pip install pyyaml")
+
+    if not api_key:
+        val = input("Enter your PrISMa API key: ").strip()
+        api_key = val
+
+    cfg = {
+        "api_key": api_key,
+        "created": pd.Timestamp.now().isoformat(),
+    }
+
+    cfg_file = get_config_path()
+    with open(cfg_file, "w") as f:
+        yaml.safe_dump(cfg, f, sort_keys=False)
+    return cfg
+
+# Get or create config - intended use by initialisation of main prisma_api class
+def get_or_create_config():
+    """Return existing config or create it interactively if missing."""
+    cfg = load_config()
+    if cfg is not None:
+        return cfg
+    return create_config_file()
+
+
+# Update dev flag in config.yaml - functional tool for user
+def update_dev_mode(dev: bool):
+    """
+    Update the dev flag in config.yaml.
+
+    Args:
+        dev: Boolean flag to enable/disable dev mode.
+
+    Returns:
+        dict: Updated config.
+    """
+    if yaml is None:
+        raise ImportError("PyYAML is required. Install with: pip install pyyaml")
+
+    cfg = load_config()
+    if cfg is None:
+        cfg = {}
+    cfg["dev"] = dev
+    cfg["modified"] = pd.Timestamp.now().isoformat()
+
+    cfg_file = get_config_path()
+    with open(cfg_file, "w") as f:
+        yaml.safe_dump(cfg, f, sort_keys=False)
+    return cfg
+
+# Update dev host in config.yaml - functional tool for user
+def update_dev_host_port(dev_host_port: str):
+    """
+    Update the dev host in config.yaml.
+
+    Args:
+        dev_host_port: Hostname or base URL for dev API.
+
+    Returns:
+        dict: Updated config.
+    """
+    if yaml is None:
+        raise ImportError("PyYAML is required. Install with: pip install pyyaml")
+
+    cfg = load_config()
+    if cfg is None:
+        cfg = {}
+
+    cfg["dev_host_port"] = dev_host_port
+    cfg["modified"] = pd.Timestamp.now().isoformat()
+
+    cfg_file = get_config_path()
+    with open(cfg_file, "w") as f:
+        yaml.safe_dump(cfg, f, sort_keys=False)
+    return cfg
+
+# Update API key in config.yaml - functional tool for user
+def update_api_key(api_key: str):
+    """
+    Update the API key in config.yaml.
+
+    Args:
+        api_key: New PrISMa API key.
+
+    Returns:
+        dict: Updated config.
+    """
+    if yaml is None:
+        raise ImportError("PyYAML is required. Install with: pip install pyyaml")
+
+    cfg = load_config()
+    if cfg is None:
+        cfg = {}
+
+    cfg["api_key"] = api_key
+    cfg["modified"] = pd.Timestamp.now().isoformat()
+
+    cfg_file = get_config_path()
+    with open(cfg_file, "w") as f:
+        yaml.safe_dump(cfg, f, sort_keys=False)
+    return cfg
+
+
+# Update API key in config.yaml - functional tool for user
+def update_dev_api_key(dev_api_key: str):
+    """
+    Update the API key in config.yaml.
+
+    Args:
+        dev_api_key: New PrISMa API key.
+
+    Returns:
+        dict: Updated config.
+    """
+    if yaml is None:
+        raise ImportError("PyYAML is required. Install with: pip install pyyaml")
+
+    cfg = load_config()
+    if cfg is None:
+        cfg = {}
+
+    cfg["dev_api_key"] = dev_api_key
+    cfg["modified"] = pd.Timestamp.now().isoformat()
+
+    cfg_file = get_config_path()
+    with open(cfg_file, "w") as f:
+        yaml.safe_dump(cfg, f, sort_keys=False)
+    return cfg
+