vantage6 5.0.0a29__tar.gz → 5.0.0a34__tar.gz

vantage6-5.0.0a34/.gitignore

@@ -0,0 +1,33 @@
+
+# documentation
+docs/_build
+docs/api-docs/_autosummary
+
+# Python
+.ipynb_checkpoints
+**/__pycache__
+**/.coverage
+
+# IDE's
+.idea/
+*.sublime-project
+*.sublime-workspace
+.vscode/
+
+# build files
+**/build/
+**/dist/
+*.egg-info
+*.code-workspace
+
+# UI build files
+**/node_modules/
+
+# Ignore DevSpace cache and log folder
+.devspace/
+dev/.data/
+dev/.tasks/
+dev/.db/
+
+# Helm
+charts/**/*.tgz

vantage6-5.0.0a34/Makefile

@@ -0,0 +1,22 @@
+# `make` is expected to be called from the directory that contains
+# this Makefile
+
+TAG ?= latest
+
+rebuild: clean build-dist
+
+build-dist:
+	# Build the PyPI package
+	uv build
+
+publish:
+	# Uploading to pypi.org
+	twine upload --repository pypi dist/*
+
+test:
+	coverage run --source=vantage6 --omit="utest.py" ./utest.py
+
+clean:
+	# Cleaning ...
+	-rm -r build
+	-rm dist/*

vantage6-5.0.0a34/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: vantage6
+Version: 5.0.0a34
+Summary: vantage6 command line interface
+Author: Vantage6 Team
+Maintainer-email: Frank Martin <f.martin@iknl.nl>, Bart van Beusekom <b.vanbeusekom@iknl.nl>
+License: MIT
+Requires-Python: >=3.13
+Requires-Dist: click==8.1.3
+Requires-Dist: colorama==0.4.6
+Requires-Dist: copier==9.9.1
+Requires-Dist: docker==7.1.0
+Requires-Dist: ipython==8.10.0
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: kubernetes==28.1.0
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: questionary==1.10.0
+Requires-Dist: rich==13.5.2
+Requires-Dist: schema==0.7.5
+Requires-Dist: sqlalchemy==2.0.37
+Requires-Dist: vantage6-client==5.0.0a34
+Requires-Dist: vantage6-common==5.0.0a34
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: coverage==7.10.2; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+  <br>
+  <a href="https://vantage6.ai"><img src="https://github.com/IKNL/guidelines/blob/master/resources/logos/vantage6.png?raw=true" alt="vantage6" width="350"></a>
+</h1>
+
+<h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
+
+---
+
+# Vantage6 CLI
+
+This package provides the command-line interface (CLI) for managing vantage6
+infrastructure instances, such as servers and nodes.
+
+## Documentation
+
+For complete documentation, installation instructions, and usage examples, please see
+the **[main Vantage6 README](https://github.com/vantage6/vantage6/blob/main/README.md)**
+.
+
+## About Vantage6
+
+Vantage6 is a Privacy Enhancing Technology (PET) Operations platform that enables
+federated learning and multi-party computation. For more information, visit
+[vantage6.ai](https://vantage6.ai) or join our
+[Discord community](https://discord.gg/yAyFf6Y).

vantage6-5.0.0a34/README.md

@@ -0,0 +1,26 @@
+<h1 align="center">
+  <br>
+  <a href="https://vantage6.ai"><img src="https://github.com/IKNL/guidelines/blob/master/resources/logos/vantage6.png?raw=true" alt="vantage6" width="350"></a>
+</h1>
+
+<h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
+
+---
+
+# Vantage6 CLI
+
+This package provides the command-line interface (CLI) for managing vantage6
+infrastructure instances, such as servers and nodes.
+
+## Documentation
+
+For complete documentation, installation instructions, and usage examples, please see
+the **[main Vantage6 README](https://github.com/vantage6/vantage6/blob/main/README.md)**
+.
+
+## About Vantage6
+
+Vantage6 is a Privacy Enhancing Technology (PET) Operations platform that enables
+federated learning and multi-party computation. For more information, visit
+[vantage6.ai](https://vantage6.ai) or join our
+[Discord community](https://discord.gg/yAyFf6Y).

vantage6-5.0.0a34/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vantage6"
+version = "5.0.0a34"
+description = "vantage6 command line interface"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Vantage6 Team"}
+]
+maintainers = [
+    {name = "Frank Martin", email = "f.martin@iknl.nl"},
+    {name = "Bart van Beusekom", email = "b.vanbeusekom@iknl.nl"}
+]
+requires-python = ">=3.13"
+dependencies = [
+    "click==8.1.3",
+    "colorama==0.4.6",
+    "copier==9.9.1",
+    "docker==7.1.0",
+    "ipython==8.10.0",
+    "jinja2==3.1.6",
+    "kubernetes==28.1.0",
+    "pandas>=2.2.3",
+    "questionary==1.10.0",
+    "rich==13.5.2",
+    "schema==0.7.5",
+    "sqlalchemy==2.0.37",
+    "vantage6-common==5.0.0a34",
+    "vantage6-client==5.0.0a34",
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage==7.10.2",
+    "black",
+    "pre-commit",
+]
+
+[project.scripts]
+v6 = "vantage6.cli.cli:cli_complete"
+
+[tool.hatch.build.targets.wheel]
+packages = ["vantage6"]
+
+[tool.hatch.build.targets.wheel.sources]
+"vantage6" = "vantage6"
+
+[tool.setuptools.packages.find]
+where = ["vantage6/cli"]
+
+[tool.setuptools.package-data]
+"vantage6/cli/" = [
+    "rabbimq/rabbitmq.config",
+    "template/node_config.j2",
+    "template/server_config.j2",
+    "template/server_import_config.j2",
+    "template/algo_store_config.j2",
+    "dev/data/olympic_athletes_2016.csv",
+    "dev/data/km_dataset.csv",
+    "prometheus/prometheus.yml",
+]

{vantage6-5.0.0a29 → vantage6-5.0.0a34}/tests_cli/test_server_cli.py

@@ -134,7 +134,7 @@ class ServerCLITest(unittest.TestCase):
         """Stop server without errors."""
 
         container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
+        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER.value}"
         containers.containers.list.return_value = [container1]
 
         runner = CliRunner()

{vantage6-5.0.0a29 → vantage6-5.0.0a34}/tests_cli/test_wizard.py

@@ -92,7 +92,7 @@ class WizardTest(unittest.TestCase):
                 False,
             ]
 
-            config = server_configuration_questionaire("vantage6")
+            config = server_configuration_questionaire()
 
             keys = [
                 "description",

vantage6-5.0.0a34/vantage6/cli/__init__.py

@@ -0,0 +1,7 @@
+"""Command line interface for the vantage6 infrastructure."""
+
+import importlib.metadata
+
+# note that here we cannot use __package__ because __package__ resolves to vantage6.cli
+# whereas the PyPi package is called vantage6
+__version__ = importlib.metadata.version("vantage6")

{vantage6-5.0.0a29 → vantage6-5.0.0a34}/vantage6/cli/algorithm/generate_algorithm_json.py

@@ -19,8 +19,6 @@ from vantage6.common.algorithm_function import (
 )
 from vantage6.common.enum import AlgorithmArgumentType, AlgorithmStepType, StrEnumBase
 
-from vantage6.algorithm.tools import DecoratorStepType
-
 from vantage6.algorithm.client import AlgorithmClient
 from vantage6.algorithm.preprocessing.algorithm_json_data import (
     PREPROCESSING_FUNCTIONS_JSON_DATA,
@@ -120,7 +118,7 @@ class Function:
         # infrastructure-defined function
         if (
             not self.func.__module__.startswith("vantage6.algorithm.")
-            or not self.json["name"] in PREPROCESSING_FUNCTIONS_JSON_DATA
+            or self.json["name"] not in PREPROCESSING_FUNCTIONS_JSON_DATA
         ):
             return
 
@@ -327,14 +325,8 @@ class Function:
     def _get_step_type(self) -> AlgorithmStepType | None:
         """Get the step type of the function"""
         decorator_type = get_vantage6_decorator_type(self.func)
-        if decorator_type == DecoratorStepType.FEDERATED:
-            return AlgorithmStepType.FEDERATED_COMPUTE
-        elif decorator_type == DecoratorStepType.CENTRAL:
-            return AlgorithmStepType.CENTRAL_COMPUTE
-        elif decorator_type == DecoratorStepType.PREPROCESSING:
-            return AlgorithmStepType.PREPROCESSING
-        elif decorator_type == DecoratorStepType.DATA_EXTRACTION:
-            return AlgorithmStepType.DATA_EXTRACTION
+        if decorator_type in AlgorithmStepType.list():
+            return decorator_type
         else:
             warning(
                 f"Unsupported decorator type: {decorator_type} for function {self.name}"

vantage6-5.0.0a34/vantage6/cli/algostore/new.py

@@ -0,0 +1,39 @@
+import click
+
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.new import new
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@click.command()
+@click.option(
+    "-n", "--name", default=None, help="Name of the configuration you want to use."
+)
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Use system folders instead of user folders. This is the default",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+    help="Use user folders instead of system folders",
+)
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option(
+    "--namespace",
+    default=None,
+    help="Kubernetes namespace to use",
+)
+def cli_algo_store_new(
+    name: str, system_folders: bool, namespace: str, context: str
+) -> None:
+    """
+    Create a new server configuration.
+    """
+
+    new(name, system_folders, namespace, context, InstanceType.ALGORITHM_STORE)

vantage6-5.0.0a34/vantage6/cli/algostore/start.py

@@ -0,0 +1,73 @@
+import click
+
+from vantage6.common import info
+from vantage6.common.globals import (
+    InstanceType,
+    Ports,
+)
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.common.start import (
+    helm_install,
+    start_port_forward,
+)
+from vantage6.cli.common.utils import (
+    attach_logs,
+    create_directory_if_not_exists,
+    select_context_and_namespace,
+)
+from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
+from vantage6.cli.globals import ChartName
+
+
+@click.command()
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option("--ip", default=None, help="IP address to listen on")
+@click.option("-p", "--port", default=None, type=int, help="Port to listen on")
+@click.option(
+    "--attach/--detach",
+    default=False,
+    help="Print server logs to the console after start",
+)
+@click_insert_context(InstanceType.ALGORITHM_STORE)
+def cli_algo_store_start(
+    ctx: AlgorithmStoreContext,
+    context: str,
+    namespace: str,
+    ip: str,
+    port: int,
+    attach: bool,
+) -> None:
+    """
+    Start the algorithm store.
+    """
+    info("Starting algorithm store...")
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    create_directory_if_not_exists(ctx.log_dir)
+
+    helm_install(
+        release_name=ctx.helm_release_name,
+        chart_name=ChartName.ALGORITHM_STORE,
+        values_file=ctx.config_file,
+        context=context,
+        namespace=namespace,
+    )
+
+    # port forward for server
+    info("Port forwarding for algorithm store")
+    start_port_forward(
+        service_name=f"{ctx.helm_release_name}-vantage6-algorithm-store-service",
+        service_port=ctx.config["store"].get("port", Ports.DEV_ALGO_STORE.value),
+        port=port or ctx.config["store"].get("port", Ports.DEV_ALGO_STORE.value),
+        ip=ip,
+        context=context,
+        namespace=namespace,
+    )
+
+    if attach:
+        attach_logs("app=store", "component=store-server")

vantage6-5.0.0a34/vantage6/cli/algostore/stop.py

@@ -0,0 +1,96 @@
+import click
+from colorama import Fore, Style
+
+from vantage6.common import error, info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.stop import helm_uninstall, stop_port_forward
+from vantage6.cli.common.utils import (
+    find_running_service_names,
+    select_context_and_namespace,
+    select_running_service,
+)
+from vantage6.cli.context import get_context
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@click.command()
+@click.option("-n", "--name", default=None, help="Configuration name")
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+    help="Search for configuration in system folders instead of user folders. "
+    "This is the default.",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    help="Search for configuration in the user folders instead of system folders.",
+)
+@click.option("--all", "all_stores", flag_value=True, help="Stop all algorithm stores")
+def cli_algo_store_stop(
+    name: str,
+    context: str,
+    namespace: str,
+    system_folders: bool,
+    all_stores: bool,
+):
+    """
+    Stop one or all running algorithm store(s).
+    """
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    running_stores = find_running_service_names(
+        instance_type=InstanceType.ALGORITHM_STORE,
+        only_system_folders=system_folders,
+        only_user_folders=not system_folders,
+        context=context,
+        namespace=namespace,
+    )
+
+    if not running_stores:
+        error("No running algorithm stores found.")
+        return
+
+    if all_stores:
+        for store in running_stores:
+            _stop_store(store["name"], namespace, context)
+    else:
+        if not name:
+            store_name = select_running_service(
+                running_stores, InstanceType.ALGORITHM_STORE
+            )
+        else:
+            ctx = get_context(InstanceType.ALGORITHM_STORE, name, system_folders)
+            store_name = ctx.helm_release_name
+
+        if store_name in running_stores:
+            _stop_store(store_name, namespace, context)
+            info(f"Stopped the {Fore.GREEN}{store_name}{Style.RESET_ALL} store.")
+        else:
+            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?!")
+
+
+def _stop_store(store_name: str, namespace: str, context: str) -> None:
+    info(f"Stopping store {store_name}...")
+
+    # uninstall the helm release
+    helm_uninstall(
+        release_name=store_name,
+        context=context,
+        namespace=namespace,
+    )
+
+    stop_port_forward(
+        service_name=f"{store_name}-vantage6-algorithm-store-service",
+    )
+
+    info(f"Store {store_name} stopped successfully.")

{vantage6-5.0.0a29/vantage6/cli/server → vantage6-5.0.0a34/vantage6/cli/common}/new.py

@@ -1,39 +1,18 @@
-import click
 from colorama import Fore, Style
 
 from vantage6.common import ensure_config_dir_writable, error, info
 from vantage6.common.globals import InstanceType
 
+from vantage6.cli.common.utils import get_main_cli_command_name
 from vantage6.cli.config import CliConfig
 from vantage6.cli.configuration_wizard import configuration_wizard
-from vantage6.cli.context.server import ServerContext
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+from vantage6.cli.context import select_context_class
 from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
 
 
-@click.command()
-@click.option(
-    "-n", "--name", default=None, help="name of the configuration you want to use."
-)
-@click.option("--system", "system_folders", flag_value=True)
-@click.option(
-    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
-)
-@click.option("--context", default=None, help="Kubernetes context to use")
-@click.option(
-    "--namespace",
-    default=None,
-    help="Kubernetes namespace to use",
-)
-def cli_server_new(
-    name: str,
-    system_folders: bool,
-    namespace: str,
-    context: str,
-) -> None:
-    """
-    Create a new server configuration.
-    """
+def new(
+    name: str, system_folders: bool, namespace: str, context: str, type_: InstanceType
+):
     cli_config = CliConfig()
     context, namespace = cli_config.compare_changes_config(
         context=context,
@@ -46,34 +25,36 @@ def cli_server_new(
     check_config_name_allowed(name)
 
     # check that this config does not exist
+    ctx_class = select_context_class(type_)
     try:
-        if ServerContext.config_exists(name, system_folders):
-            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already " "exists!")
+        if ctx_class.config_exists(name, system_folders):
+            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already exists!")
             exit(1)
     except Exception as e:
         error(e)
         exit(1)
 
+    command_name = get_main_cli_command_name(type_)
+
     # Check that we can write in this folder
     if not ensure_config_dir_writable(system_folders):
         error("Your user does not have write access to all folders. Exiting")
         info(
-            f"Create a new server using '{Fore.GREEN}v6 server new "
+            f"Create a new {command_name} using '{Fore.GREEN}v6 {command_name} new "
             f"--user{Style.RESET_ALL}' instead!"
         )
         exit(1)
 
     # create config in ctx location
     try:
-        cfg_file = configuration_wizard(InstanceType.SERVER, name, system_folders)
+        cfg_file = configuration_wizard(type_, name, system_folders)
     except KeyboardInterrupt:
         error("Configuration creation aborted.")
         exit(1)
     info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
 
-    # info(f"root user created.")
     flag = "" if system_folders else "--user"
     info(
-        f"You can start the server by running {Fore.GREEN}v6 server start "
-        f"{flag}{Style.RESET_ALL}"
+        f"You can start the {command_name} by running {Fore.GREEN}v6 {command_name} "
+        f"start {flag}{Style.RESET_ALL}"
     )