vantage6 5.0.0a29__tar.gz → 5.0.0a33__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of vantage6 might be problematic. Click here for more details.

Files changed (94) hide show
  1. vantage6-5.0.0a33/.gitignore +33 -0
  2. vantage6-5.0.0a33/Makefile +22 -0
  3. vantage6-5.0.0a33/PKG-INFO +54 -0
  4. vantage6-5.0.0a33/README.md +26 -0
  5. vantage6-5.0.0a33/pyproject.toml +65 -0
  6. vantage6-5.0.0a33/vantage6/cli/__init__.py +7 -0
  7. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algorithm/generate_algorithm_json.py +3 -11
  8. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/context/algorithm_store.py +1 -1
  9. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/context/node.py +7 -2
  10. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/context/server.py +1 -1
  11. vantage6-5.0.0a29/PKG-INFO +0 -238
  12. vantage6-5.0.0a29/setup.cfg +0 -4
  13. vantage6-5.0.0a29/setup.py +0 -80
  14. vantage6-5.0.0a29/vantage6/cli/__build__ +0 -1
  15. vantage6-5.0.0a29/vantage6/cli/__init__.py +0 -3
  16. vantage6-5.0.0a29/vantage6/cli/_version.py +0 -23
  17. vantage6-5.0.0a29/vantage6.egg-info/PKG-INFO +0 -238
  18. vantage6-5.0.0a29/vantage6.egg-info/SOURCES.txt +0 -86
  19. vantage6-5.0.0a29/vantage6.egg-info/dependency_links.txt +0 -1
  20. vantage6-5.0.0a29/vantage6.egg-info/entry_points.txt +0 -5
  21. vantage6-5.0.0a29/vantage6.egg-info/requires.txt +0 -19
  22. vantage6-5.0.0a29/vantage6.egg-info/top_level.txt +0 -2
  23. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/tests_cli/__init__.py +0 -0
  24. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/tests_cli/test_client_script.py +0 -0
  25. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/tests_cli/test_example.py +0 -0
  26. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/tests_cli/test_node_cli.py +0 -0
  27. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/tests_cli/test_server_cli.py +0 -0
  28. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/tests_cli/test_wizard.py +0 -0
  29. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algorithm/create.py +0 -0
  30. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algorithm/update.py +0 -0
  31. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/attach.py +0 -0
  32. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/files.py +0 -0
  33. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/list.py +0 -0
  34. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/new.py +0 -0
  35. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/remove.py +0 -0
  36. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/start.py +0 -0
  37. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/algostore/stop.py +0 -0
  38. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/cli.py +0 -0
  39. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/common/decorator.py +0 -0
  40. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/common/start.py +0 -0
  41. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/common/stop.py +0 -0
  42. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/common/utils.py +0 -0
  43. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/config.py +0 -0
  44. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/configuration_manager.py +0 -0
  45. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/configuration_wizard.py +0 -0
  46. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/context/__init__.py +0 -0
  47. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/context/base_server.py +0 -0
  48. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/dev/create.py +0 -0
  49. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/dev/data/km_dataset.csv +0 -0
  50. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/dev/remove.py +0 -0
  51. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/globals.py +0 -0
  52. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/attach.py +0 -0
  53. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/clean.py +0 -0
  54. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/common/__init__.py +0 -0
  55. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/create_private_key.py +0 -0
  56. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/files.py +0 -0
  57. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/list.py +0 -0
  58. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/new.py +0 -0
  59. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/remove.py +0 -0
  60. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/restart.py +0 -0
  61. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/set_api_key.py +0 -0
  62. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/start.py +0 -0
  63. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/stop.py +0 -0
  64. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/node/version.py +0 -0
  65. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/prometheus/monitoring_manager.py +0 -0
  66. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/prometheus/prometheus.yml +0 -0
  67. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/rabbitmq/__init__.py +0 -0
  68. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/rabbitmq/definitions.py +0 -0
  69. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/rabbitmq/queue_manager.py +0 -0
  70. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/rabbitmq/rabbitmq.config +0 -0
  71. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/attach.py +0 -0
  72. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/common/__init__.py +0 -0
  73. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/files.py +0 -0
  74. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/import_.py +0 -0
  75. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/list.py +0 -0
  76. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/new.py +0 -0
  77. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/remove.py +0 -0
  78. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/shell.py +0 -0
  79. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/start.py +0 -0
  80. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/stop.py +0 -0
  81. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/server/version.py +0 -0
  82. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/template/algo_store_config.j2 +0 -0
  83. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/template/node_config.j2 +0 -0
  84. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/template/server_config.j2 +0 -0
  85. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/template/server_import_config.j2 +0 -0
  86. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/test/algo_test_scripts/algo_test_arguments.py +0 -0
  87. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/test/algo_test_scripts/algo_test_script.py +0 -0
  88. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/test/client_script.py +0 -0
  89. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/test/common/diagnostic_runner.py +0 -0
  90. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/test/feature_tester.py +0 -0
  91. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/test/integration_test.py +0 -0
  92. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/use/context.py +0 -0
  93. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/use/namespace.py +0 -0
  94. {vantage6-5.0.0a29 → vantage6-5.0.0a33}/vantage6/cli/utils.py +0 -0
@@ -0,0 +1,33 @@
1
+
2
+ # documentation
3
+ docs/_build
4
+ docs/api-docs/_autosummary
5
+
6
+ # Python
7
+ .ipynb_checkpoints
8
+ **/__pycache__
9
+ **/.coverage
10
+
11
+ # IDE's
12
+ .idea/
13
+ *.sublime-project
14
+ *.sublime-workspace
15
+ .vscode/
16
+
17
+ # build files
18
+ **/build/
19
+ **/dist/
20
+ *.egg-info
21
+ *.code-workspace
22
+
23
+ # UI build files
24
+ **/node_modules/
25
+
26
+ # Ignore DevSpace cache and log folder
27
+ .devspace/
28
+ dev/.data/
29
+ dev/.tasks/
30
+ dev/.db/
31
+
32
+ # Helm
33
+ charts/**/*.tgz
@@ -0,0 +1,22 @@
1
+ # `make` is expected to be called from the directory that contains
2
+ # this Makefile
3
+
4
+ TAG ?= latest
5
+
6
+ rebuild: clean build-dist
7
+
8
+ build-dist:
9
+ # Build the PyPI package
10
+ uv build
11
+
12
+ publish:
13
+ # Uploading to pypi.org
14
+ twine upload --repository pypi dist/*
15
+
16
+ test:
17
+ coverage run --source=vantage6 --omit="utest.py" ./utest.py
18
+
19
+ clean:
20
+ # Cleaning ...
21
+ -rm -r build
22
+ -rm dist/*
@@ -0,0 +1,54 @@
1
+ Metadata-Version: 2.4
2
+ Name: vantage6
3
+ Version: 5.0.0a33
4
+ Summary: vantage6 command line interface
5
+ Author: Vantage6 Team
6
+ Maintainer-email: Frank Martin <f.martin@iknl.nl>, Bart van Beusekom <b.vanbeusekom@iknl.nl>
7
+ License: MIT
8
+ Requires-Python: >=3.13
9
+ Requires-Dist: click==8.1.3
10
+ Requires-Dist: colorama==0.4.6
11
+ Requires-Dist: copier==9.2.0
12
+ Requires-Dist: docker==7.1.0
13
+ Requires-Dist: ipython==8.10.0
14
+ Requires-Dist: jinja2==3.1.6
15
+ Requires-Dist: kubernetes==28.1.0
16
+ Requires-Dist: pandas>=2.2.3
17
+ Requires-Dist: questionary==1.10.0
18
+ Requires-Dist: rich==13.5.2
19
+ Requires-Dist: schema==0.7.5
20
+ Requires-Dist: sqlalchemy==2.0.37
21
+ Requires-Dist: vantage6-client==5.0.0a33
22
+ Requires-Dist: vantage6-common==5.0.0a33
23
+ Provides-Extra: dev
24
+ Requires-Dist: black; extra == 'dev'
25
+ Requires-Dist: coverage==7.10.2; extra == 'dev'
26
+ Requires-Dist: pre-commit; extra == 'dev'
27
+ Description-Content-Type: text/markdown
28
+
29
+ <h1 align="center">
30
+ <br>
31
+ <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>
32
+ </h1>
33
+
34
+ <h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
35
+
36
+ ---
37
+
38
+ # Vantage6 CLI
39
+
40
+ This package provides the command-line interface (CLI) for managing vantage6
41
+ infrastructure instances, such as servers and nodes.
42
+
43
+ ## Documentation
44
+
45
+ For complete documentation, installation instructions, and usage examples, please see
46
+ the **[main Vantage6 README](https://github.com/vantage6/vantage6/blob/main/README.md)**
47
+ .
48
+
49
+ ## About Vantage6
50
+
51
+ Vantage6 is a Privacy Enhancing Technology (PET) Operations platform that enables
52
+ federated learning and multi-party computation. For more information, visit
53
+ [vantage6.ai](https://vantage6.ai) or join our
54
+ [Discord community](https://discord.gg/yAyFf6Y).
@@ -0,0 +1,26 @@
1
+ <h1 align="center">
2
+ <br>
3
+ <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>
4
+ </h1>
5
+
6
+ <h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
7
+
8
+ ---
9
+
10
+ # Vantage6 CLI
11
+
12
+ This package provides the command-line interface (CLI) for managing vantage6
13
+ infrastructure instances, such as servers and nodes.
14
+
15
+ ## Documentation
16
+
17
+ For complete documentation, installation instructions, and usage examples, please see
18
+ the **[main Vantage6 README](https://github.com/vantage6/vantage6/blob/main/README.md)**
19
+ .
20
+
21
+ ## About Vantage6
22
+
23
+ Vantage6 is a Privacy Enhancing Technology (PET) Operations platform that enables
24
+ federated learning and multi-party computation. For more information, visit
25
+ [vantage6.ai](https://vantage6.ai) or join our
26
+ [Discord community](https://discord.gg/yAyFf6Y).
@@ -0,0 +1,65 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "vantage6"
7
+ version = "5.0.0a33"
8
+ description = "vantage6 command line interface"
9
+ readme = "README.md"
10
+ license = {text = "MIT"}
11
+ authors = [
12
+ {name = "Vantage6 Team"}
13
+ ]
14
+ maintainers = [
15
+ {name = "Frank Martin", email = "f.martin@iknl.nl"},
16
+ {name = "Bart van Beusekom", email = "b.vanbeusekom@iknl.nl"}
17
+ ]
18
+ requires-python = ">=3.13"
19
+ dependencies = [
20
+ "click==8.1.3",
21
+ "colorama==0.4.6",
22
+ "copier==9.2.0",
23
+ "docker==7.1.0",
24
+ "ipython==8.10.0",
25
+ "jinja2==3.1.6",
26
+ "kubernetes==28.1.0",
27
+ "pandas>=2.2.3",
28
+ "questionary==1.10.0",
29
+ "rich==13.5.2",
30
+ "schema==0.7.5",
31
+ "sqlalchemy==2.0.37",
32
+ "vantage6-common==5.0.0a33",
33
+ "vantage6-client==5.0.0a33",
34
+ ]
35
+
36
+ [project.optional-dependencies]
37
+ dev = [
38
+ "coverage==7.10.2",
39
+ "black",
40
+ "pre-commit",
41
+ ]
42
+
43
+ [project.scripts]
44
+ v6 = "vantage6.cli.cli:cli_complete"
45
+
46
+ [tool.hatch.build.targets.wheel]
47
+ packages = ["vantage6"]
48
+
49
+ [tool.hatch.build.targets.wheel.sources]
50
+ "vantage6" = "vantage6"
51
+
52
+ [tool.setuptools.packages.find]
53
+ where = ["vantage6/cli"]
54
+
55
+ [tool.setuptools.package-data]
56
+ "vantage6/cli/" = [
57
+ "rabbimq/rabbitmq.config",
58
+ "template/node_config.j2",
59
+ "template/server_config.j2",
60
+ "template/server_import_config.j2",
61
+ "template/algo_store_config.j2",
62
+ "dev/data/olympic_athletes_2016.csv",
63
+ "dev/data/km_dataset.csv",
64
+ "prometheus/prometheus.yml",
65
+ ]
@@ -0,0 +1,7 @@
1
+ """Command line interface for the vantage6 infrastructure."""
2
+
3
+ import importlib.metadata
4
+
5
+ # note that here we cannot use __package__ because __package__ resolves to vantage6.cli
6
+ # whereas the PyPi package is called vantage6
7
+ __version__ = importlib.metadata.version("vantage6")
@@ -19,8 +19,6 @@ from vantage6.common.algorithm_function import (
19
19
  )
20
20
  from vantage6.common.enum import AlgorithmArgumentType, AlgorithmStepType, StrEnumBase
21
21
 
22
- from vantage6.algorithm.tools import DecoratorStepType
23
-
24
22
  from vantage6.algorithm.client import AlgorithmClient
25
23
  from vantage6.algorithm.preprocessing.algorithm_json_data import (
26
24
  PREPROCESSING_FUNCTIONS_JSON_DATA,
@@ -120,7 +118,7 @@ class Function:
120
118
  # infrastructure-defined function
121
119
  if (
122
120
  not self.func.__module__.startswith("vantage6.algorithm.")
123
- or not self.json["name"] in PREPROCESSING_FUNCTIONS_JSON_DATA
121
+ or self.json["name"] not in PREPROCESSING_FUNCTIONS_JSON_DATA
124
122
  ):
125
123
  return
126
124
 
@@ -327,14 +325,8 @@ class Function:
327
325
  def _get_step_type(self) -> AlgorithmStepType | None:
328
326
  """Get the step type of the function"""
329
327
  decorator_type = get_vantage6_decorator_type(self.func)
330
- if decorator_type == DecoratorStepType.FEDERATED:
331
- return AlgorithmStepType.FEDERATED_COMPUTE
332
- elif decorator_type == DecoratorStepType.CENTRAL:
333
- return AlgorithmStepType.CENTRAL_COMPUTE
334
- elif decorator_type == DecoratorStepType.PREPROCESSING:
335
- return AlgorithmStepType.PREPROCESSING
336
- elif decorator_type == DecoratorStepType.DATA_EXTRACTION:
337
- return AlgorithmStepType.DATA_EXTRACTION
328
+ if decorator_type in AlgorithmStepType.list():
329
+ return decorator_type
338
330
  else:
339
331
  warning(
340
332
  f"Unsupported decorator type: {decorator_type} for function {self.name}"
@@ -2,7 +2,7 @@ from __future__ import annotations
2
2
 
3
3
  from vantage6.common.globals import APPNAME, InstanceType
4
4
 
5
- from vantage6.cli._version import __version__
5
+ from vantage6.cli import __version__
6
6
  from vantage6.cli.configuration_manager import ServerConfigurationManager
7
7
  from vantage6.cli.context.base_server import BaseServerContext
8
8
  from vantage6.cli.globals import (
@@ -7,7 +7,7 @@ from pathlib import Path
7
7
  from vantage6.common.context import AppContext
8
8
  from vantage6.common.globals import APPNAME, STRING_ENCODING, InstanceType
9
9
 
10
- from vantage6.cli._version import __version__
10
+ from vantage6.cli import __version__
11
11
  from vantage6.cli.configuration_manager import NodeConfigurationManager
12
12
  from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
13
13
 
@@ -40,7 +40,12 @@ class NodeContext(AppContext):
40
40
  logger_prefix: str = "",
41
41
  ):
42
42
  super().__init__(
43
- InstanceType.NODE, instance_name, system_folders=system_folders
43
+ InstanceType.NODE,
44
+ instance_name,
45
+ system_folders=system_folders,
46
+ config_file=config_file,
47
+ print_log_header=print_log_header,
48
+ logger_prefix=logger_prefix,
44
49
  )
45
50
  if print_log_header:
46
51
  self.log.info("vantage6 version '%s'", __version__)
@@ -4,7 +4,7 @@ from pathlib import Path
4
4
 
5
5
  from vantage6.common.globals import APPNAME, InstanceType
6
6
 
7
- from vantage6.cli._version import __version__
7
+ from vantage6.cli import __version__
8
8
  from vantage6.cli.configuration_manager import ServerConfigurationManager
9
9
  from vantage6.cli.context.base_server import BaseServerContext
10
10
  from vantage6.cli.globals import (
@@ -1,238 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: vantage6
3
- Version: 5.0.0a29
4
- Summary: vantage6 command line interface
5
- Home-page: https://github.com/vantage6/vantage6
6
- Requires-Python: >=3.13
7
- Description-Content-Type: text/markdown
8
- Requires-Dist: click==8.1.3
9
- Requires-Dist: colorama==0.4.6
10
- Requires-Dist: copier==9.2.0
11
- Requires-Dist: docker==7.1.0
12
- Requires-Dist: ipython==8.10.0
13
- Requires-Dist: jinja2==3.1.6
14
- Requires-Dist: kubernetes==28.1.0
15
- Requires-Dist: pandas>=2.2.3
16
- Requires-Dist: questionary==1.10.0
17
- Requires-Dist: rich==13.5.2
18
- Requires-Dist: schema==0.7.5
19
- Requires-Dist: sqlalchemy==2.0.37
20
- Requires-Dist: vantage6-common==5.0.0a29
21
- Requires-Dist: vantage6-client==5.0.0a29
22
- Provides-Extra: dev
23
- Requires-Dist: coverage==6.4.4; extra == "dev"
24
- Requires-Dist: black; extra == "dev"
25
- Requires-Dist: pre-commit; extra == "dev"
26
- Dynamic: description
27
- Dynamic: description-content-type
28
- Dynamic: home-page
29
- Dynamic: provides-extra
30
- Dynamic: requires-dist
31
- Dynamic: requires-python
32
- Dynamic: summary
33
-
34
- <h1 align="center">
35
- <br>
36
- <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>
37
- </h1>
38
-
39
- <h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
40
- <h3 align="center">
41
-
42
- <!-- Badges go here-->
43
-
44
- [![Release](https://github.com/vantage6/vantage6/actions/workflows/release.yml/badge.svg)](https://github.com/vantage6/vantage6/actions/workflows/release.yml)
45
- [![PyPI vantage6](https://badge.fury.io/py/vantage6.svg)](https://badge.fury.io/py/vantage6)
46
- [![Unittests](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml)
47
- [![Coverage Status](https://coveralls.io/repos/github/vantage6/vantage6/badge.svg?branch=main)](https://coveralls.io/github/vantage6/vantage6?branch=main)
48
- [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2e60ac3b3f284620805f7399cba317be)](https://app.codacy.com/gh/vantage6/vantage6/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
49
- [![DOI](https://zenodo.org/badge/492818831.svg)](https://zenodo.org/badge/latestdoi/492818831)
50
- [![Discord](https://img.shields.io/discord/643526403207331841)](https://discord.gg/yAyFf6Y)
51
- [![Research software directory](https://img.shields.io/badge/rsd-vantage6-deepskyblue)](https://research-software-directory.org/software/vantage6)
52
-
53
- </h3>
54
-
55
- <p align="center">
56
- <a href="#books-quickstart">Quickstart</a> •
57
- <a href="#project-structure">Project structure</a> •
58
- <a href="#gift_heart-join-the-community">Join the community</a> •
59
- <a href="#scroll-license">License</a> •
60
- <a href="#black_nib-code-of-conduct">Code of conduct</a> •
61
- <a href="#black_nib-references">References</a>
62
- </p>
63
-
64
- ---
65
-
66
- This repository is contains all the **vantage6** infrastructure source code. The **vantage6** technology enables to manage and deploy privacy enhancing technologies like Federated Learning (FL) and Multi-Party Computation (MPC). Please visit our [website](https://vantage6.ai) to learn more!
67
-
68
- You can find more (user) documentation at [readthedocs](https://docs.vantage6.ai). If you have any questions, suggestions or just want to chat about federated learning: join our [Discord)](https://discord.gg/yAyFf6Y) channel.
69
-
70
- ## Infrastructure overview
71
-
72
- ![Vantage6 architecture overview](docs/images/overview-infrastructure.png)
73
-
74
- _A High level overview of the vantage6 infrastructure. Vantage6 has both a
75
- client-server and peer-to-peer architecture. The client is used by the researcher to
76
- create (PET) computation requests. It is also used to manage users, organizations and
77
- collaborations. The server contains users, organizations, collaborations, tasks and
78
- their results. It provides a central access point for both the clients and nodes. The
79
- nodes have access to privacy sensitive data and handle computation requests retrieved
80
- from the server. Computation request are executed as separate containers on the node.
81
- These containers are connected to containers at other nodes by a internal network._
82
-
83
- ## :books: Quickstart
84
-
85
- ### Requirements
86
-
87
- The **vantage6** infrastructure is delivered in Docker images. To run these images, you
88
- need to have [Docker](https://docs.docker.com/get-docker/) installed. To install the
89
- latest version of the vantage6 CLI, you need to have
90
- [Python](https://www.python.org/downloads/), we recommend using an environment manager
91
- like [mini-conda](https://docs.conda.io/en/latest/miniconda.html).
92
-
93
- Install the latest version of the vantage6 CLI by using:
94
-
95
- ```bash
96
- pip install vantage6
97
- ```
98
-
99
- This install the `v6` commands, which allows you to manage your nodes and servers. To view all available options, run:
100
-
101
- ```bash
102
- v6 --help
103
- ```
104
-
105
- For example you can create a local test setup by using:
106
-
107
- ```bash
108
- v6 dev create-demo-network
109
- ```
110
-
111
- This creates a local network with a server and two nodes. You can start the network by running:
112
-
113
- ```bash
114
- v6 dev start-demo-network
115
- ```
116
-
117
- This will start the server and nodes in the background. You can view the logs by running:
118
-
119
- ```bash
120
- # View node logs
121
- v6 node attach
122
-
123
- # View server logs
124
- v6 server attach
125
- ```
126
-
127
- From here you can use the [vantage6-client](https://pypi.org/project/vantage6-client)
128
- to interact with the server. The demo network has a pre-configured organization with
129
- the following credentials:
130
-
131
- - Username: `dev_admin`
132
- - Password: `password`
133
-
134
- For example, you can create a new organization by running:
135
-
136
- ```python
137
- from vantage6.client import Client
138
-
139
- client = Client(
140
- server_url='http://127.0.0.1:7601/api',
141
- auth_url='http://127.0.0.1:8080',
142
- log_level='debug'
143
- )
144
- client.authenticate()
145
- client.setup_encryption(None)
146
-
147
- client.organization.create(
148
- name='My organization',
149
- address1='My address',
150
- address2='My address',
151
- zipcode='1234AB',
152
- country='The Netherlands',
153
- domain='my-organization.com'
154
- )
155
- ```
156
-
157
- You can find more (user) documentation at [readthedocs](https://docs.vantage6.ai)
158
-
159
- ## Project structure
160
-
161
- ### PYPI packages
162
-
163
- This repository is home to 6 PyPi packages:
164
-
165
- - [vantage6](https://pypi.org/project/vantage6) -> _CLI for managing node and server instances_
166
- - [vantage6-client](https://pypi.org/project/vantage6-client) -> _Python client for interacting with the vantage6-server_
167
- - [vantage6-algorithm-tools](https://pypi.org/project/vantage6-algorithm-tools) -> _Python tools to facilitate algorithm development_
168
- - [vantage6-node](https://pypi.org/project/vantage6-node) -> _Node application package_
169
- - [vantage6-server](https://pypi.org/project/vantage6-server) -> _Server application package_
170
- - [vantage6-algorithm-store](https://pypi.org/project/vantage6-algorithm-store) -> _Algorithm store application package_
171
- - [vantage6-common](https://pypi.org/project/vantage6-common) -> _Package with common vantage6 functions_
172
- - [vantage6-backend-common](https://pypi.org/project/vantage6-backend-common) -> _Package with functions common to central server and algorithm store_
173
-
174
- **Note that when using vantage6 you do not install the _server_ and _node_ packages. These are delivered to you in Docker images.**
175
-
176
- This repository also hosts the code for the vantage6 user interface (UI). The UI
177
- is an Angular web application that can be used to interact with the vantage6 server
178
- easily.
179
-
180
- ### Docker images
181
-
182
- The vantage6 infrastructure is delivered in Docker images. All Docker images are stored
183
- in our private [Harbor](https://goharbor.io/) registry. The most important images are:
184
-
185
- - `harbor2.vantage6.ai/infrastructure/node:VERSION` -> _Node application Docker image_
186
- - `harbor2.vantage6.ai/infrastructure/server:VERSION` -> _Server application Docker image_
187
- - `harbor2.vantage6.ai/infrastructure/ui:VERSION` -> _User interface Docker image_
188
- - `harbor2.vantage6.ai/infrastructure/algorithm-store:VERSION` -> _Algorithm store Docker image_
189
-
190
- with `VERSION` being the full semantic version of the vantage6 infrastructure, e.g.
191
- `4.0.0` or `4.1.0rc0`.
192
-
193
- Several other images are used to support the infrastructure:
194
-
195
- - `harbor2.vantage6.ai/infrastructure/infrastructure-base:VERSION` -> _Base image for the infrastructure_
196
- - `harbor2.vantage6.ai/infrastructure/alpine` -> _Alpine image used for vpn traffic forwarding_
197
-
198
- And finally there are some images released for algorithm development:
199
-
200
- - `harbor2.vantage6.ai/infrastructure/algorithm-base:MAJOR.MINOR` -> _Base image for algorithm development_
201
- - `harbor2.vantage6.ai/infrastructure/algorithm-ohdsi-base:MAJOR.MINOR` -> _Extended algorithm base image for OHDSI algorithm development_
202
-
203
- ## :gift_heart: Join the community!
204
-
205
- We hope to continue developing, improving, and supporting **vantage6** with the help of
206
- the federated learning community. If you are interested in contributing, first of all,
207
- thank you! Second, please take a look at our
208
- [contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html)
209
- and our [code of conduct](CODE_OF_CONDUCT.md).
210
-
211
- <a href="https://github.com/vantage6/vantage6/graphs/contributors">
212
- <img src="https://contrib.rocks/image?repo=vantage6/vantage6" />
213
- </a>
214
-
215
- ## :scroll: License
216
-
217
- This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
218
-
219
- ## :black_nib: Code of Conduct
220
-
221
- Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). **By participating in any way in this project you agree to abide by its terms.**
222
-
223
- ## :black_nib: References
224
-
225
- If you are using **vantage6**, please cite this repository as well as the accompanying papers as follows:
226
-
227
- > - F. Martin, M. Sieswerda, H. Alradhi, et al. vantage6. Available at https://doi.org/10.5281/zenodo.7221216. Accessed on MONTH, 20XX.
228
- > - A. Moncada-Torres, F. Martin, M. Sieswerda, J. van Soest, G. Gelijnse. VANTAGE6: an open source priVAcy preserviNg federaTed leArninG infrastructurE for Secure Insight eXchange. AMIA Annual Symposium Proceedings, 2020, p. 870-877. [[BibTeX](https://arturomoncadatorres.com/bibtex/moncada-torres2020vantage6.txt), [PDF](https://vantage6.ai/vantage6/)]
229
- > - D. Smits\*, B. van Beusekom\*, F. Martin, L. Veen, G. Geleijnse, A. Moncada-Torres, An Improved Infrastructure for Privacy-Preserving Analysis of Patient Data, Proceedings of the International Conference of Informatics, Management, and Technology in Healthcare (ICIMTH), vol. 25, 2022, p. 144-147. [[BibTeX](https://arturomoncadatorres.com/bibtex/smits2022improved.txt), [PDF](https://ebooks.iospress.nl/volumearticle/60190)]
230
-
231
- ---
232
-
233
- <p align="center">
234
- <a href="https://vantage6.ai">vantage6.ai</a> •
235
- <a href="https://discord.gg/yAyFf6Y">Discord</a> •
236
- <a href="https://vantage6.discourse.group/">Discourse</a> •
237
- <a href="https://docs.vantage6.ai">User documentation</a>
238
- </p>
@@ -1,4 +0,0 @@
1
- [egg_info]
2
- tag_build =
3
- tag_date = 0
4
-
@@ -1,80 +0,0 @@
1
- import codecs
2
- import os
3
- from codecs import open
4
- from os import path
5
- from pathlib import Path
6
-
7
- from setuptools import find_namespace_packages, setup
8
-
9
- # get current directory
10
- here = Path(path.abspath(path.dirname(__file__)))
11
- parent_dir = here.parent.absolute()
12
-
13
- # get the long description from the README file
14
- with codecs.open(path.join(parent_dir, "README.md"), encoding="utf-8") as f:
15
- long_description = f.read()
16
-
17
- # Read the API version from disk. This file should be located in the package
18
- # folder, since it's also used to set the pkg.__version__ variable.
19
- version_path = os.path.join(here, "vantage6", "cli", "_version.py")
20
- version_ns = {"__file__": version_path}
21
- with open(version_path) as f:
22
- exec(f.read(), {}, version_ns)
23
-
24
-
25
- # setup the package
26
- setup(
27
- name="vantage6",
28
- version=version_ns["__version__"],
29
- description="vantage6 command line interface",
30
- long_description=long_description,
31
- long_description_content_type="text/markdown",
32
- url="https://github.com/vantage6/vantage6",
33
- packages=find_namespace_packages(),
34
- python_requires=">=3.13",
35
- install_requires=[
36
- "click==8.1.3",
37
- "colorama==0.4.6",
38
- "copier==9.2.0",
39
- "docker==7.1.0",
40
- "ipython==8.10.0",
41
- "jinja2==3.1.6",
42
- "kubernetes==28.1.0",
43
- "pandas>=2.2.3",
44
- "questionary==1.10.0",
45
- "rich==13.5.2",
46
- "schema==0.7.5",
47
- "sqlalchemy==2.0.37",
48
- f"vantage6-common == {version_ns['__version__']}",
49
- f"vantage6-client == {version_ns['__version__']}",
50
- ],
51
- extras_require={
52
- "dev": [
53
- "coverage==6.4.4",
54
- "black",
55
- "pre-commit",
56
- ]
57
- },
58
- package_data={
59
- "vantage6.cli": [
60
- "__build__",
61
- "rabbitmq/rabbitmq.config",
62
- "template/node_config.j2",
63
- "template/server_config.j2",
64
- "template/server_import_config.j2",
65
- "template/algo_store_config.j2",
66
- "dev/data/olympic_athletes_2016.csv",
67
- "dev/data/km_dataset.csv",
68
- "prometheus/prometheus.yml",
69
- ],
70
- },
71
- entry_points={
72
- "console_scripts": [
73
- "v6=vantage6.cli.cli:cli_complete",
74
- # TODO v5+ remove vnode/vserver/vdev aliases (?)
75
- "vnode=vantage6.cli.cli:cli_node",
76
- "vserver=vantage6.cli.cli:cli_server",
77
- "vdev=vantage6.cli.cli:cli_dev",
78
- ]
79
- },
80
- )
@@ -1 +0,0 @@
1
- 29
@@ -1,3 +0,0 @@
1
- """Command line interface for the vantage6 infrastructure."""
2
-
3
- from ._version import version_info, __version__ # noqa: F401
@@ -1,23 +0,0 @@
1
- import os
2
- import json
3
-
4
- here = os.path.abspath(os.path.dirname(__file__))
5
-
6
- with open(os.path.join(here, "__build__")) as fp:
7
- __build__ = json.load(fp)
8
-
9
- # Module version
10
- version_info = (5, 0, 0, "alpha", __build__, 0)
11
-
12
- # Module version stage suffix map
13
- _specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}
14
- version = f"{version_info[0]}.{version_info[1]}.{version_info[2]}"
15
- pre_release = (
16
- ""
17
- if version_info[3] == "final"
18
- else _specifier_[version_info[3]] + str(version_info[4])
19
- )
20
- post_release = "" if not version_info[5] else f".post{version_info[5]}"
21
-
22
- # Module version accessible using thomas.__version__
23
- __version__ = f"{version}{pre_release}{post_release}"