vantage6 5.0.0a26__tar.gz → 5.0.0a33__tar.gz

vantage6-5.0.0a33/.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.0a33/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.0a33/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: vantage6
+Version: 5.0.0a33
+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.2.0
+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.0a33
+Requires-Dist: vantage6-common==5.0.0a33
+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.0a33/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.0a33/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vantage6"
+version = "5.0.0a33"
+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.2.0",
+    "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.0a33",
+    "vantage6-client==5.0.0a33",
+]
+
+[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.0a26 → vantage6-5.0.0a33}/tests_cli/test_server_cli.py

@@ -1,18 +1,19 @@
 import unittest
-
-from unittest.mock import MagicMock, patch
 from pathlib import Path
+from unittest.mock import MagicMock, patch
+
 from click.testing import CliRunner
 
 from vantage6.common.globals import APPNAME, InstanceType
+
 from vantage6.cli.common.utils import attach_logs
-from vantage6.cli.server.start import cli_server_start
-from vantage6.cli.server.list import cli_server_configuration_list
+from vantage6.cli.server.attach import cli_server_attach
 from vantage6.cli.server.files import cli_server_files
 from vantage6.cli.server.import_ import cli_server_import
+from vantage6.cli.server.list import cli_server_configuration_list
 from vantage6.cli.server.new import cli_server_new
+from vantage6.cli.server.start import cli_server_start
 from vantage6.cli.server.stop import cli_server_stop
-from vantage6.cli.server.attach import cli_server_attach
 
 
 class ServerCLITest(unittest.TestCase):
@@ -133,7 +134,7 @@ class ServerCLITest(unittest.TestCase):
         """Stop server without errors."""
 
         container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER.value}"
+        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
         containers.containers.list.return_value = [container1]
 
         runner = CliRunner()

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/tests_cli/test_wizard.py

@@ -1,15 +1,15 @@
 import unittest
-
 from pathlib import Path
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
+
+from vantage6.common.globals import InstanceType, NodePolicy
 
 from vantage6.cli.configuration_wizard import (
-    node_configuration_questionaire,
-    server_configuration_questionaire,
     configuration_wizard,
+    node_configuration_questionaire,
     select_configuration_questionaire,
+    server_configuration_questionaire,
 )
-from vantage6.common.globals import InstanceType, NodePolicy
 
 module_path = "vantage6.cli.configuration_wizard"
 
@@ -70,8 +70,8 @@ class WizardTest(unittest.TestCase):
         for key in keys:
             self.assertIn(key, config)
         nested_keys = [
-            ["policies", NodePolicy.ALLOWED_ALGORITHMS],
-            ["policies", NodePolicy.ALLOWED_ALGORITHM_STORES],
+            ["policies", NodePolicy.ALLOWED_ALGORITHMS.value],
+            ["policies", NodePolicy.ALLOWED_ALGORITHM_STORES.value],
         ]
         for nesting in nested_keys:
             current_config = config

vantage6-5.0.0a33/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.0a26 → vantage6-5.0.0a33}/vantage6/cli/algorithm/generate_algorithm_json.py

@@ -1,27 +1,25 @@
-import os
-import sys
 import importlib
 import inspect
 import json
-
-from enum import Enum
+import os
+import sys
 from inspect import getmembers, isfunction, ismodule, signature
 from pathlib import Path
 from types import ModuleType, UnionType
 from typing import Any, OrderedDict
 
 import click
-import questionary as q
 import pandas as pd
+import questionary as q
 
-from vantage6.algorithm.client import AlgorithmClient
-from vantage6.algorithm.tools import DecoratorStepType
 from vantage6.common import error, info, warning
-from vantage6.common.enum import AlgorithmArgumentType, AlgorithmStepType
 from vantage6.common.algorithm_function import (
     get_vantage6_decorator_type,
     is_vantage6_algorithm_func,
 )
+from vantage6.common.enum import AlgorithmArgumentType, AlgorithmStepType, StrEnumBase
+
+from vantage6.algorithm.client import AlgorithmClient
 from vantage6.algorithm.preprocessing.algorithm_json_data import (
     PREPROCESSING_FUNCTIONS_JSON_DATA,
 )
@@ -54,7 +52,7 @@ class MergePreference:
         cls._prefer_existing = None
 
 
-class FunctionArgumentType(Enum):
+class FunctionArgumentType(StrEnumBase):
     """Type of the function argument"""
 
     PARAMETER = "parameter"
@@ -80,7 +78,7 @@ class Function:
             "display_name": self._pretty_print_name(self.name),
             "standalone": True,
             "description": self._extract_headline_of_docstring(),
-            "step_type": self.step_type,
+            "step_type": self.step_type.value if self.step_type else None,
             "ui_visualizations": [],
             "arguments": [],
             "databases": [],
@@ -91,7 +89,7 @@ class Function:
         # if the function is a data extraction function, the first argument is a dict
         # with database connection details. This argument should not be added to the
         # function json. Instead, a database should be added to the function json.
-        if self.step_type == AlgorithmStepType.DATA_EXTRACTION.value:
+        if self.step_type == AlgorithmStepType.DATA_EXTRACTION:
             function_json["databases"].append(
                 {
                     "name": "Database",
@@ -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
 
@@ -211,11 +209,12 @@ class Function:
             }, FunctionArgumentType.DATAFRAME
         else:
             # This is a regular function parameter
+            type_ = self._get_argument_type(param, name)
             arg_json = {
                 "name": name,
                 "display_name": self._pretty_print_name(name),
                 "description": self._extract_parameter_description(name),
-                "type": self.get_argument_type(param, name),
+                "type": type_.value if type_ else None,
                 "required": param.default == inspect.Parameter.empty,
                 "has_default_value": param.default != inspect.Parameter.empty,
                 "is_frontend_only": False,
@@ -247,7 +246,9 @@ class Function:
                 "will not be added."
             )
 
-    def get_argument_type(self, param: inspect.Parameter, name: str) -> str:
+    def _get_argument_type(
+        self, param: inspect.Parameter, name: str
+    ) -> AlgorithmArgumentType | None:
         """Get the type of the argument"""
         if isinstance(param.annotation, UnionType):
             # Arguments with default values may have type 'str | None'. If that is the
@@ -276,23 +277,23 @@ class Function:
             type_ = param.annotation
 
         if type_ == str:
-            return AlgorithmArgumentType.STRING.value
+            return AlgorithmArgumentType.STRING
         elif type_ == dict:
-            return AlgorithmArgumentType.JSON.value
+            return AlgorithmArgumentType.JSON
         elif type_ == int:
-            return AlgorithmArgumentType.INTEGER.value
+            return AlgorithmArgumentType.INTEGER
         elif type_ == float:
-            return AlgorithmArgumentType.FLOAT.value
+            return AlgorithmArgumentType.FLOAT
         elif type_ == bool:
-            return AlgorithmArgumentType.BOOLEAN.value
+            return AlgorithmArgumentType.BOOLEAN
         elif type_ == list:
-            return AlgorithmArgumentType.STRINGS.value
+            return AlgorithmArgumentType.STRINGS
         elif type_ == list[str]:
-            return AlgorithmArgumentType.STRINGS.value
+            return AlgorithmArgumentType.STRINGS
         elif type_ == list[int]:
-            return AlgorithmArgumentType.INTEGERS.value
+            return AlgorithmArgumentType.INTEGERS
         elif type_ == list[float]:
-            return AlgorithmArgumentType.FLOATS.value
+            return AlgorithmArgumentType.FLOATS
         else:
             warning(
                 f"Unsupported argument type: {param.annotation} for argument {name} "
@@ -321,21 +322,14 @@ class Function:
         header = " ".join(line.strip() for line in lines if line.strip() != "")
         return header
 
-    def _get_step_type(self) -> str:
+    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.value
-        elif decorator_type == DecoratorStepType.CENTRAL:
-            return AlgorithmStepType.CENTRAL_COMPUTE.value
-        elif decorator_type == DecoratorStepType.PREPROCESSING:
-            return AlgorithmStepType.PREPROCESSING.value
-        elif decorator_type == DecoratorStepType.DATA_EXTRACTION:
-            return AlgorithmStepType.DATA_EXTRACTION.value
+        if decorator_type in AlgorithmStepType.list():
+            return decorator_type
         else:
             warning(
-                f"Unsupported decorator type: {decorator_type} for function "
-                f"{self.name}"
+                f"Unsupported decorator type: {decorator_type} for function {self.name}"
             )
             return None
 

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/algostore/list.py

@@ -2,6 +2,7 @@ import click
 
 from vantage6.common.docker.addons import check_docker_running
 from vantage6.common.globals import InstanceType
+
 from vantage6.cli.common.utils import get_server_configuration_list
 
 
@@ -12,4 +13,4 @@ def cli_algo_store_configuration_list() -> None:
     """
     check_docker_running()
 
-    get_server_configuration_list(InstanceType.ALGORITHM_STORE.value)
+    get_server_configuration_list(InstanceType.ALGORITHM_STORE)

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/algostore/start.py

@@ -7,6 +7,8 @@ from vantage6.common.globals import (
     InstanceType,
     Ports,
 )
+
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.common.start import (
     attach_logs,
     check_for_start,
@@ -17,7 +19,6 @@ from vantage6.cli.common.start import (
     pull_infra_image,
 )
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
-from vantage6.cli.common.decorator import click_insert_context
 
 
 @click.command()
@@ -27,13 +28,12 @@ from vantage6.cli.common.decorator import click_insert_context
 @click.option(
     "--keep/--auto-remove",
     default=False,
-    help="Keep image after algorithm store has been stopped. Useful " "for debugging",
+    help="Keep image after algorithm store has been stopped. Useful for debugging",
 )
 @click.option(
     "--mount-src",
     default="",
-    help="Override vantage6 source code in container with the source"
-    " code in this path",
+    help="Override vantage6 source code in container with the source code in this path",
 )
 @click.option(
     "--attach/--detach",
@@ -54,7 +54,7 @@ def cli_algo_store_start(
     Start the algorithm store server.
     """
     info("Starting algorithm store...")
-    docker_client = check_for_start(ctx, InstanceType.ALGORITHM_STORE.value)
+    docker_client = check_for_start(ctx, InstanceType.ALGORITHM_STORE)
 
     image = get_image(image, ctx, "algorithm-store", DEFAULT_ALGO_STORE_IMAGE)
 
@@ -84,7 +84,7 @@ def cli_algo_store_start(
     info(cmd)
 
     info("Run Docker container")
-    port_ = str(port or ctx.config["port"] or Ports.DEV_ALGO_STORE.value)
+    port_ = str(port or ctx.config["port"] or Ports.DEV_ALGO_STORE)
     container = docker_client.containers.run(
         image,
         command=cmd,

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/algostore/stop.py

@@ -2,12 +2,13 @@ import click
 import docker
 from colorama import Fore, Style
 
-from vantage6.common import info, warning, error
+from vantage6.common import error, info, warning
 from vantage6.common.docker.addons import (
     check_docker_running,
     remove_container_if_exists,
 )
 from vantage6.common.globals import APPNAME, InstanceType
+
 from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
 
@@ -23,7 +24,7 @@ def cli_algo_store_stop(ctx: AlgorithmStoreContext, all_stores: bool):
     client = docker.from_env()
 
     running_stores = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.ALGORITHM_STORE.value}"}
+        filters={"label": f"{APPNAME}-type={InstanceType.ALGORITHM_STORE}"}
     )
 
     if not running_stores:

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/common/decorator.py

@@ -1,11 +1,13 @@
 from functools import wraps
 from pathlib import Path
+
 import click
 
 from vantage6.common import error
 from vantage6.common.globals import InstanceType
+
 from vantage6.cli.configuration_wizard import select_configuration_questionaire
-from vantage6.cli.context import select_context_class, get_context
+from vantage6.cli.context import get_context, select_context_class
 
 
 def click_insert_context(

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/common/start.py

@@ -33,8 +33,8 @@ from vantage6.cli.common.utils import print_log_worker
 from vantage6.cli.context import AlgorithmStoreContext, ServerContext
 from vantage6.cli.globals import AlgoStoreGlobals, ServerGlobals
 from vantage6.cli.utils import (
-    validate_input_cmd_args,
     check_config_name_allowed,
+    validate_input_cmd_args,
 )
 
 
@@ -69,7 +69,7 @@ def check_for_start(ctx: AppContext, type_: InstanceType) -> DockerClient:
     )
     for server in running_servers:
         if server.name == f"{APPNAME}-{ctx.name}-{ctx.scope}-{type_}":
-            error(f"Server {Fore.RED}{ctx.name}{Style.RESET_ALL} " "is already running")
+            error(f"Server {Fore.RED}{ctx.name}{Style.RESET_ALL} is already running")
             exit(1)
     return docker_client
 
@@ -304,8 +304,6 @@ def attach_logs(container: Container, type_: InstanceType) -> None:
     type_ : InstanceType
         The type of instance to attach the logs for
     """
-    if isinstance(type_, enum.Enum):
-        type_ = type_.value
     logs = container.attach(stream=True, logs=True, stdout=True)
     Thread(target=print_log_worker, args=(logs,), daemon=True).start()
     while True:

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/common/utils.py

@@ -78,7 +78,7 @@ def get_running_servers(
     return [server.name for server in running_servers]
 
 
-def get_server_configuration_list(instance_type: InstanceType.SERVER) -> None:
+def get_server_configuration_list(instance_type: InstanceType) -> None:
     """
     Print list of available server configurations.
 
@@ -90,11 +90,7 @@ def get_server_configuration_list(instance_type: InstanceType.SERVER) -> None:
     client = docker.from_env()
     ctx_class = select_context_class(instance_type)
 
-    instance_type_value = (
-        instance_type.value if isinstance(instance_type, enum.Enum) else instance_type
-    )
-
-    running_server_names = get_running_servers(client, instance_type_value)
+    running_server_names = get_running_servers(client, instance_type)
     header = "\nName" + (21 * " ") + "Status" + (10 * " ") + "System/User"
 
     click.echo(header)
@@ -108,26 +104,24 @@ def get_server_configuration_list(instance_type: InstanceType.SERVER) -> None:
     for config in configs:
         status = (
             running
-            if f"{APPNAME}-{config.name}-system-{instance_type_value}"
-            in running_server_names
+            if f"{APPNAME}-{config.name}-system-{instance_type}" in running_server_names
             else stopped
         )
-        click.echo(f"{config.name:25}" f"{status:25} System ")
+        click.echo(f"{config.name:25}{status:25} System ")
 
     # user folders
     configs, f2 = ctx_class.available_configurations(system_folders=False)
     for config in configs:
         status = (
             running
-            if f"{APPNAME}-{config.name}-user-{instance_type_value}"
-            in running_server_names
+            if f"{APPNAME}-{config.name}-user-{instance_type}" in running_server_names
             else stopped
         )
-        click.echo(f"{config.name:25}" f"{status:25} User   ")
+        click.echo(f"{config.name:25}{status:25} User   ")
 
     click.echo("-" * 85)
     if len(f1) + len(f2):
-        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+        warning(f"{Fore.RED}Failed imports: {len(f1) + len(f2)}{Style.RESET_ALL}")
 
 
 def print_log_worker(logs_stream: Iterable[bytes]) -> None:

{vantage6-5.0.0a26 → vantage6-5.0.0a33}/vantage6/cli/configuration_manager.py

@@ -1,4 +1,6 @@
-from schema import And, Or, Use, Optional
+from typing import Self
+
+from schema import And, Optional, Or, Use
 
 from vantage6.common.configuration_manager import Configuration, ConfigurationManager
 
@@ -63,7 +65,7 @@ class NodeConfigurationManager(ConfigurationManager):
         super().__init__(conf_class=NodeConfiguration, name=name)
 
     @classmethod
-    def from_file(cls, path: str) -> "NodeConfigurationManager":
+    def from_file(cls, path: str) -> Self:
         """
         Create a new instance of the NodeConfigurationManager from a
         configuration file.
@@ -95,7 +97,7 @@ class ServerConfigurationManager(ConfigurationManager):
         super().__init__(conf_class=ServerConfiguration, name=name)
 
     @classmethod
-    def from_file(cls, path) -> "ServerConfigurationManager":
+    def from_file(cls, path) -> Self:
         """
         Create a new instance of the ServerConfigurationManager from a
         configuration file.