Merge pull request #12 from ni-kismet/users/fvisser/add-function-support

Add function support

Author: fredvisser

.env.example

@@ -0,0 +1,17 @@
+# SystemLink Function Services Configuration
+# These environment variables can be set in this .env file for local development
+
+# Unified Function Management Service URL (definitions + executions)
+# FUNCTION_SERVICE_URL=http://localhost:8080
+
+# Legacy separate execution service URL is no longer used:
+# (FUNCTION_EXECUTION_SERVICE_URL has been deprecated)
+
+# Or specify a common base URL used to derive the unified service path
+# SYSTEMLINK_API_URL=http://localhost:8080
+
+# API Key for authentication
+# SYSTEMLINK_API_KEY=your_api_key_here
+
+# SSL Verification (set to false for local development with self-signed certificates)
+# SLCLI_SSL_VERIFY=false

.gitignore

@@ -83,3 +83,4 @@ tests/unit/__pycache__/
 
 # E2E test configuration
 tests/e2e/e2e_config.json
+.env

README.md

@@ -9,6 +9,7 @@ authors = ["Fred Visser <fred.visser@emerson.com>"]
 slcli = "slcli.__main__:cli"
 build-pyinstaller = "scripts.build_pyinstaller:main"
 update-version = "scripts.update_version:main"
+lint = "scripts.lint:main"
 
 [tool.poetry.dependencies]
 python = ">=3.11.1,<3.14"

pyproject.toml

@@ -0,0 +1,57 @@
+"""Convenience script to run style linting and formatting.
+
+Default (no flags):
+    - Run style guide lint checks (non-modifying)
+    - Run black in check mode (no file changes)
+
+With --fix:
+    - Run style guide lint checks (still non-modifying; separate fixer not provided)
+    - Run black to auto-format the codebase
+
+Equivalent commands:
+    Check: ni-python-styleguide lint && black --check .
+    Fix:   ni-python-styleguide lint && black .
+
+Exposed as `poetry run lint` via pyproject.toml.
+"""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+from typing import List
+
+
+def _run(cmd: List[str]) -> int:
+    """Run a subprocess command and return its exit code."""
+    proc = subprocess.run(cmd, stdout=sys.stdout, stderr=sys.stderr)  # noqa: S603,S607
+    return proc.returncode
+
+
+def main() -> None:
+    """Execute lint steps; optionally format when --fix provided."""
+    fix = "--fix" in sys.argv[1:]
+    # Remove our flag so tools don't see it
+    if fix:
+        sys.argv = [sys.argv[0]] + [a for a in sys.argv[1:] if a != "--fix"]
+
+    code = 0
+    # Lint (non-modifying)
+    if _run([sys.executable, "-m", "ni_python_styleguide", "lint"]) != 0:
+        code = 1
+
+    # Formatting
+    black_cmd = [sys.executable, "-m", "black"]
+    if fix:
+        black_cmd.append(".")
+    else:
+        black_cmd.extend(["--check", "."])
+
+    if _run(black_cmd) != 0:
+        code = 1
+
+    sys.exit(code)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

scripts/lint.py

@@ -0,0 +1,81 @@
+"""Configuration management for slcli."""
+
+import json
+import os
+from pathlib import Path
+from typing import Dict, Optional
+
+
+def get_config_file_path() -> Path:
+    """Get the path to the slcli configuration file."""
+    # Use XDG_CONFIG_HOME if set, otherwise use ~/.config
+    if "XDG_CONFIG_HOME" in os.environ:
+        config_dir = Path(os.environ["XDG_CONFIG_HOME"]) / "slcli"
+    else:
+        config_dir = Path.home() / ".config" / "slcli"
+
+    config_dir.mkdir(parents=True, exist_ok=True)
+    return config_dir / "config.json"
+
+
+def load_config() -> Dict[str, str]:
+    """Load configuration from the config file.
+
+    Returns:
+        Dictionary containing configuration values
+    """
+    config_file = get_config_file_path()
+
+    if not config_file.exists():
+        return {}
+
+    try:
+        with open(config_file, "r", encoding="utf-8") as f:
+            return json.load(f)
+    except (json.JSONDecodeError, OSError):
+        # If config file is corrupted or unreadable, return empty config
+        return {}
+
+
+def save_config(config: Dict[str, str]) -> None:
+    """Save configuration to the config file.
+
+    Args:
+        config: Dictionary containing configuration values to save
+    """
+    config_file = get_config_file_path()
+
+    try:
+        with open(config_file, "w", encoding="utf-8") as f:
+            json.dump(config, f, indent=2)
+    except OSError as e:
+        raise RuntimeError(f"Failed to save configuration: {e}")
+
+
+def get_function_service_url() -> Optional[str]:
+    """Get the configured URL for the Function Service.
+
+    Returns:
+        The configured function service URL, or None if not configured
+    """
+    config = load_config()
+    return config.get("function_service_url")
+
+
+def set_function_service_url(url: str) -> None:
+    """Set the URL for the Function Service.
+
+    Args:
+        url: The URL to use for function commands
+    """
+    config = load_config()
+    config["function_service_url"] = url
+    save_config(config)
+
+
+def remove_function_service_url() -> None:
+    """Remove the configured Function Service URL."""
+    config = load_config()
+    if "function_service_url" in config:
+        del config["function_service_url"]
+        save_config(config)