vantage6-algorithm-tools 4.15.1__tar.gz → 5.0.0__tar.gz

vantage6_algorithm_tools-5.0.0/.gitignore

@@ -0,0 +1,37 @@
+
+# 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/
+dev/.log/
+
+# Helm
+charts/**/*.tgz
+
+# MacOS
+.DS_Store

vantage6_algorithm_tools-5.0.0/Makefile

@@ -0,0 +1,19 @@
+# `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/*
+
+clean:
+	# Cleaning ...
+	-rm -r build
+	-rm dist/*

vantage6_algorithm_tools-5.0.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: vantage6-algorithm-tools
+Version: 5.0.0
+Summary: Vantage6 algorithm tools
+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: openpyxl>=3.0.0
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: psycopg2-binary==2.9.10
+Requires-Dist: pyarrow>=16.1.0
+Requires-Dist: pyfiglet==1.0.4
+Requires-Dist: pyjwt==2.12.1
+Requires-Dist: sparqlwrapper>=2.0.0
+Requires-Dist: sqlalchemy>=1.4.46
+Requires-Dist: vantage6-common==5.0.0
+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 Algorithm Tools
+
+This package provides Python tools to facilitate algorithm development for vantage6.
+
+## 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 view our
+[documentation](https://docs.vantage6.ai).

vantage6_algorithm_tools-5.0.0/README.md

@@ -0,0 +1,25 @@
+<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 Algorithm Tools
+
+This package provides Python tools to facilitate algorithm development for vantage6.
+
+## 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 view our
+[documentation](https://docs.vantage6.ai).

vantage6_algorithm_tools-5.0.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vantage6-algorithm-tools"
+version = "5.0.0"
+description = "Vantage6 algorithm tools"
+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 = [
+    "openpyxl>=3.0.0",
+    "pandas>=2.2.3",
+    # psycopg2-binary is not used directly in algorithm tools, but is necessary when
+    # running SQL queries on a postgres database.
+    "psycopg2-binary==2.9.10",
+    "pyarrow>=16.1.0",
+    "pyjwt==2.12.1",
+    "pyfiglet==1.0.4",
+    "SPARQLWrapper>=2.0.0",
+    "sqlalchemy>=1.4.46",
+    "vantage6-common==5.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage==7.10.2",
+    "black",
+    "pre-commit",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["vantage6"]
+
+[tool.hatch.build.targets.wheel.sources]
+"vantage6" = "vantage6"

vantage6_algorithm_tools-4.15.1/tests/test_deserialization.py → vantage6_algorithm_tools-5.0.0/tests/_test_deserialization.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+
 from vantage6.common.client import deserialization
 
 SIMPLE_TARGET_DATA = {"key": "value"}

vantage6_algorithm_tools-4.15.1/tests/test_docker_wrapper.py → vantage6_algorithm_tools-5.0.0/tests/_test_docker_wrapper.py

@@ -4,22 +4,24 @@
 
 # import pandas as pd
 
+# from vantage6.common.globals import ContainerEnvNames
+
 # from vantage6.algorithm.tools import wrapper
 
 # MODULE_NAME = "algorithm_module"
 # DATA = "column1,column2\n1,2"
 # TOKEN = "This is a fake token"
-# INPUT_PARAMETERS = {"method": "hello_world"}
+# # INPUT_PARAMETERS = {"method": "hello_world"}
 # SEPARATOR = "."
 # SAMPLE_DB = pd.DataFrame([[1, 2]], columns=["column1", "column2"])
 
 # MOCK_SPARQL_ENDPOINT = "sparql://some_triplestore"
 
 
-# # def test_json_input_without_format_raises_deserializationexception(tmp_path):
+# # def test_json_input_without_format_raises_deserializationerror(tmp_path):
 # #     """
 # #     It should only be possible to provide json input if it is preceded by the
-# #     string "json." in unicode. Otherwise a `DeserializationException` should
+# #     string "json." in unicode. Otherwise a `DeserializationError` should
 # #     be thrown.
 # #     """
 # #     input_file = tmp_path / 'input.json'
@@ -27,7 +29,7 @@
 # #     with input_file.open('wb') as f:
 # #         f.write(json.dumps(INPUT_PARAMETERS).encode())
 
-# #     with raises(DeserializationException):
+# #     with raises(DeserializationError):
 # #         run_docker_wrapper_with_echo_db(input_file, tmp_path)
 
 
@@ -123,5 +125,71 @@
 
 #     _run_algorithm_method.assert_called_once()
 
+# def run_docker_wrapper_with_echo_db(input_file, tmp_path):
+#     """
+#     Run the `echo_db` testing algorithm through the wrapper code. The wrapper
+#     communicates through files whose locations are stored in the `INPUT_FILE`,
+#     `TOKEN_FILE` and `DATABASE_URI` environment variables. The output of the
+#     algorithm is stored in the location specified in environment variable
+#     `OUTPUT_FILE`.
+
+#     :param input_file: input arguments to the wrapper and algorithm
+#     :param tmp_path: temporary path to store additional files.
+#     :return:
+#     """
+#     db_file = tmp_path / "db_file.csv"
+#     token_file = tmp_path / "token.txt"
+#     output_file = tmp_path / "output_file.pkl"
+#     db_file.write_text(DATA)
+#     token_file.write_text(TOKEN)
+#     with patch("vantage6.algorithm.tools.docker_wrapper.os") as mock_os:
+#         mock_os.environ = {
+#             ContainerEnvNames.INPUT_FILE.value: input_file,
+#             ContainerEnvNames.TOKEN_FILE.value: token_file,
+#             ContainerEnvNames.DATABASE_URI.value: db_file,
+#             ContainerEnvNames.OUTPUT_FILE.value: output_file,
+#         }
+
+#         wrapper.docker_wrapper(MODULE_NAME)
+#     return output_file
+
+
+# @patch("vantage6.algorithm.tools.wrap._run_algorithm_method")
+# @patch("vantage6.algorithm.tools.docker_wrapper.os")
+# @patch("vantage6.algorithm.tools.docker_wrapper.SPARQLWrapper")
+# def test_sparql_docker_wrapper_passes_dataframe(
+#     SPARQLWrapper: MagicMock,
+#     os: MagicMock,
+#     _run_algorithm_method: MagicMock,
+#     tmp_path: Path,
+# ):
+#     input_file = tmp_path / "input_file.pkl"
+#     token_file = tmp_path / "token.txt"
+#     output_file = tmp_path / "output.pkl"
+
+#     environ = {
+#         ContainerEnvNames.INPUT_FILE.value: str(input_file),
+#         ContainerEnvNames.TOKEN_FILE.value: str(token_file),
+#         ContainerEnvNames.DATABASE_URI.value: MOCK_SPARQL_ENDPOINT,
+#         ContainerEnvNames.OUTPUT_FILE.value: str(output_file),
+#     }
+
+#     os.environ = environ
+
+#     input_args = {"query": "select *"}
+
+#     with input_file.open("wb") as f:
+#         json.dumps(input_args, f)
+
+#     with token_file.open("w") as f:
+#         f.write(TOKEN)
+
+#     _run_algorithm_method.return_value = pd.DataFrame()
+#     SPARQLWrapper.return_value.query.return_value.convert.return_value = DATA.encode()
+
+#     wrapper.sparql_wrapper(MODULE_NAME)
+
+#     _run_algorithm_method.assert_called_once()
+
 #     target_df = pd.DataFrame([[1, 2]], columns=["column1", "column2"])
 #     pd.testing.assert_frame_equal(target_df, _run_algorithm_method.call_args[0][0])