vantage6 5.0.0a26__py3-none-any.whl → 5.0.0a33__py3-none-any.whl

tests_cli/test_wizard.py

@@ -1,141 +0,0 @@
-import unittest
-
-from pathlib import Path
-from unittest.mock import patch, MagicMock
-
-from vantage6.cli.configuration_wizard import (
-    node_configuration_questionaire,
-    server_configuration_questionaire,
-    configuration_wizard,
-    select_configuration_questionaire,
-)
-from vantage6.common.globals import InstanceType, NodePolicy
-
-module_path = "vantage6.cli.configuration_wizard"
-
-
-class WizardTest(unittest.TestCase):
-    @staticmethod
-    def prompts(*args, **kwargs):
-        result = {}
-        for arg in args[0]:
-            name = arg["name"]
-            if name == "default":  # default db path
-                result[name] = "/some/path/db.sqlite"
-            else:
-                if "default" in arg:
-                    result[name] = arg["default"]
-                else:
-                    result[name] = None
-        return result
-
-    @patch("vantage6.cli.configuration_wizard.NodeClient.authenticate")
-    def test_node_wizard(self, authenticate):
-        """An error is printed when docker is not running"""
-        authenticate.return_value = None
-
-        with patch(f"{module_path}.q") as q:
-            q.unsafe_prompt.side_effect = self.prompts
-            q.confirm.return_value.unsafe_ask.side_effect = [
-                True,  # add a database
-                False,  # don't enable two-factor authentication
-                True,  # add VPN server
-                True,  # add algorithm policies
-                True,  # add single algorithms to allowed_algorithms
-                "some-image",  # algorithm image to whitelist
-                False,  # don't add another algorithm image
-                True,  # add algorithm stores to allowed_algorithm_stores
-                "some-store",  # algorithm store to whitelist
-                False,  # don't add another algorithm store
-                False,  # answer question on combining policies on store level and
-                # single algorithm level
-                False,  # don't abort if no server connection is made to pull
-                # collaboration settings
-                True,  # Enable encryption
-            ]
-            dirs = MagicMock(data="/")
-            config = node_configuration_questionaire(dirs, "iknl")
-
-        keys = [
-            "api_key",
-            "server_url",
-            "port",
-            "api_path",
-            "task_dir",
-            "databases",
-            "logging",
-            "encryption",
-            "vpn_subnet",
-        ]
-        for key in keys:
-            self.assertIn(key, config)
-        nested_keys = [
-            ["policies", NodePolicy.ALLOWED_ALGORITHMS],
-            ["policies", NodePolicy.ALLOWED_ALGORITHM_STORES],
-        ]
-        for nesting in nested_keys:
-            current_config = config
-            for key in nesting:
-                self.assertIn(key, current_config)
-                current_config = current_config[key]
-
-    def test_server_wizard(self):
-        with patch(f"{module_path}.q") as q:
-            q.unsafe_prompt.side_effect = self.prompts
-            q.confirm.return_value.unsafe_ask.side_effect = [
-                True,
-                True,
-                True,
-                True,
-                True,
-                True,
-                False,
-            ]
-
-            config = server_configuration_questionaire("vantage6")
-
-            keys = [
-                "description",
-                "ip",
-                "port",
-                "api_path",
-                "uri",
-                "allow_drop_all",
-                "logging",
-                "vpn_server",
-                "rabbitmq",
-                "two_factor_auth",
-                "algorithm_stores",
-            ]
-
-            for key in keys:
-                self.assertIn(key, config)
-
-    @patch(f"{module_path}.node_configuration_questionaire")
-    @patch(f"{module_path}.server_configuration_questionaire")
-    @patch(f"{module_path}.ServerConfigurationManager")
-    @patch(f"{module_path}.NodeConfigurationManager")
-    @patch("vantage6.cli.configuration_wizard.AppContext")
-    def test_configuration_wizard_interface(
-        self, context, node_m, server_m, server_q, node_q
-    ):
-        context.instance_folders.return_value = {"config": "/some/path/"}
-
-        file_ = configuration_wizard(InstanceType.NODE, "vtg6", False)
-        self.assertEqual(Path("/some/path/vtg6.yaml"), file_)
-
-        file_ = configuration_wizard(InstanceType.SERVER, "vtg6", True)
-        self.assertEqual(Path("/some/path/vtg6.yaml"), file_)
-
-    @patch("vantage6.cli.configuration_wizard.AppContext.available_configurations")
-    def test_select_configuration(self, available_configurations):
-        config = MagicMock()
-        config.name = "vtg6"
-
-        available_configurations.return_value = [[config], []]
-
-        with patch(f"{module_path}.q") as q:
-            q.select.return_value.unsafe_ask.return_value = "vtg6"
-            name = select_configuration_questionaire(InstanceType.NODE, True)
-
-        self.assertEqual(name, "vtg6")

vantage6/cli/__build__

@@ -1 +0,0 @@
-26

vantage6/cli/_version.py

@@ -1,23 +0,0 @@
-import os
-import json
-
-here = os.path.abspath(os.path.dirname(__file__))
-
-with open(os.path.join(here, "__build__")) as fp:
-    __build__ = json.load(fp)
-
-# Module version
-version_info = (5, 0, 0, "alpha", __build__, 0)
-
-# Module version stage suffix map
-_specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}
-version = f"{version_info[0]}.{version_info[1]}.{version_info[2]}"
-pre_release = (
-    ""
-    if version_info[3] == "final"
-    else _specifier_[version_info[3]] + str(version_info[4])
-)
-post_release = "" if not version_info[5] else f".post{version_info[5]}"
-
-# Module version accessible using thomas.__version__
-__version__ = f"{version}{pre_release}{post_release}"

vantage6-5.0.0a26.dist-info/METADATA

@@ -1,231 +0,0 @@
-Metadata-Version: 2.1
-Name: vantage6
-Version: 5.0.0a26
-Summary: vantage6 command line interface
-Home-page: https://github.com/vantage6/vantage6
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-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>=1.5.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-common==5.0.0a26
-Requires-Dist: vantage6-client==5.0.0a26
-Provides-Extra: dev
-Requires-Dist: coverage==6.4.4; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-
-<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>
-<h3 align="center">
-
-<!-- Badges go here-->
-
-[![Release](https://github.com/vantage6/vantage6/actions/workflows/release.yml/badge.svg)](https://github.com/vantage6/vantage6/actions/workflows/release.yml)
-[![PyPI vantage6](https://badge.fury.io/py/vantage6.svg)](https://badge.fury.io/py/vantage6)
-[![Unittests](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/vantage6/vantage6/actions/workflows/unit_tests.yml)
-[![Coverage Status](https://coveralls.io/repos/github/vantage6/vantage6/badge.svg?branch=main)](https://coveralls.io/github/vantage6/vantage6?branch=main)
-[![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)
-[![DOI](https://zenodo.org/badge/492818831.svg)](https://zenodo.org/badge/latestdoi/492818831)
-[![Discord](https://img.shields.io/discord/643526403207331841)](https://discord.gg/yAyFf6Y)
-[![Research software directory](https://img.shields.io/badge/rsd-vantage6-deepskyblue)](https://research-software-directory.org/software/vantage6)
-
-</h3>
-
-<p align="center">
-  <a href="#books-quickstart">Quickstart</a> •
-  <a href="#project-structure">Project structure</a> •
-  <a href="#gift_heart-join-the-community">Join the community</a> •
-  <a href="#scroll-license">License</a> •
-  <a href="#black_nib-code-of-conduct">Code of conduct</a> •
-  <a href="#black_nib-references">References</a>
-</p>
-
----
-
-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!
-
-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.
-
-## Infrastructure overview
-
-![Vantage6 architecture overview](docs/images/overview-infrastructure.png)
-
-_A High level overview of the vantage6 infrastructure. Vantage6 has both a
-client-server and peer-to-peer architecture. The client is used by the researcher to
-create (PET) computation requests. It is also used to manage users, organizations and
-collaborations. The server contains users, organizations, collaborations, tasks and
-their results. It provides a central access point for both the clients and nodes. The
-nodes have access to privacy sensitive data and handle computation requests retrieved
-from the server. Computation request are executed as separate containers on the node.
-These containers are connected to containers at other nodes by a internal network._
-
-## :books: Quickstart
-
-### Requirements
-
-The **vantage6** infrastructure is delivered in Docker images. To run these images, you
-need to have [Docker](https://docs.docker.com/get-docker/) installed. To install the
-latest version of the vantage6 CLI, you need to have
-[Python](https://www.python.org/downloads/), we recommend using an environment manager
-like [mini-conda](https://docs.conda.io/en/latest/miniconda.html).
-
-Install the latest version of the vantage6 CLI by using:
-
-```bash
-pip install vantage6
-```
-
-This install the `v6` commands, which allows you to manage your nodes and servers. To view all available options, run:
-
-```bash
-v6 --help
-```
-
-For example you can create a local test setup by using:
-
-```bash
-v6 dev create-demo-network
-```
-
-This creates a local network with a server and two nodes. You can start the network by running:
-
-```bash
-v6 dev start-demo-network
-```
-
-This will start the server and nodes in the background. You can view the logs by running:
-
-```bash
-# View node logs
-v6 node attach
-
-# View server logs
-v6 server attach
-```
-
-From here you can use the [vantage6-client](https://pypi.org/project/vantage6-client)
-to interact with the server. The demo network has a pre-configured organization with
-the following credentials:
-
-- Username: `dev_admin`
-- Password: `password`
-
-For example, you can create a new organization by running:
-
-```python
-from vantage6.client import Client
-
-client = Client(
-  server_url='http://127.0.0.1:7601/api',
-  auth_url='http://127.0.0.1:8080',
-  log_level='debug'
-)
-client.authenticate()
-client.setup_encryption(None)
-
-client.organization.create(
-    name='My organization',
-    address1='My address',
-    address2='My address',
-    zipcode='1234AB',
-    country='The Netherlands',
-    domain='my-organization.com'
-)
-```
-
-You can find more (user) documentation at [readthedocs](https://docs.vantage6.ai)
-
-## Project structure
-
-### PYPI packages
-
-This repository is home to 6 PyPi packages:
-
-- [vantage6](https://pypi.org/project/vantage6) -> _CLI for managing node and server instances_
-- [vantage6-client](https://pypi.org/project/vantage6-client) -> _Python client for interacting with the vantage6-server_
-- [vantage6-algorithm-tools](https://pypi.org/project/vantage6-algorithm-tools) -> _Python tools to facilitate algorithm development_
-- [vantage6-node](https://pypi.org/project/vantage6-node) -> _Node application package_
-- [vantage6-server](https://pypi.org/project/vantage6-server) -> _Server application package_
-- [vantage6-algorithm-store](https://pypi.org/project/vantage6-algorithm-store) -> _Algorithm store application package_
-- [vantage6-common](https://pypi.org/project/vantage6-common) -> _Package with common vantage6 functions_
-- [vantage6-backend-common](https://pypi.org/project/vantage6-backend-common) -> _Package with functions common to central server and algorithm store_
-
-**Note that when using vantage6 you do not install the _server_ and _node_ packages. These are delivered to you in Docker images.**
-
-This repository also hosts the code for the vantage6 user interface (UI). The UI
-is an Angular web application that can be used to interact with the vantage6 server
-easily.
-
-### Docker images
-
-The vantage6 infrastructure is delivered in Docker images. All Docker images are stored
-in our private [Harbor](https://goharbor.io/) registry. The most important images are:
-
-- `harbor2.vantage6.ai/infrastructure/node:VERSION` -> _Node application Docker image_
-- `harbor2.vantage6.ai/infrastructure/server:VERSION` -> _Server application Docker image_
-- `harbor2.vantage6.ai/infrastructure/ui:VERSION` -> _User interface Docker image_
-- `harbor2.vantage6.ai/infrastructure/algorithm-store:VERSION` -> _Algorithm store Docker image_
-
-with `VERSION` being the full semantic version of the vantage6 infrastructure, e.g.
-`4.0.0` or `4.1.0rc0`.
-
-Several other images are used to support the infrastructure:
-
-- `harbor2.vantage6.ai/infrastructure/infrastructure-base:VERSION` -> _Base image for the infrastructure_
-- `harbor2.vantage6.ai/infrastructure/alpine` -> _Alpine image used for vpn traffic forwarding_
-
-And finally there are some images released for algorithm development:
-
-- `harbor2.vantage6.ai/infrastructure/algorithm-base:MAJOR.MINOR` -> _Base image for algorithm development_
-- `harbor2.vantage6.ai/infrastructure/algorithm-ohdsi-base:MAJOR.MINOR` -> _Extended algorithm base image for OHDSI algorithm development_
-
-## :gift_heart: Join the community!
-
-We hope to continue developing, improving, and supporting **vantage6** with the help of
-the federated learning community. If you are interested in contributing, first of all,
-thank you! Second, please take a look at our
-[contributing guidelines](https://docs.vantage6.ai/en/main/devops/contribute.html)
-and our [code of conduct](CODE_OF_CONDUCT.md).
-
-<a href="https://github.com/vantage6/vantage6/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=vantage6/vantage6" />
-</a>
-
-## :scroll: License
-
-This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
-
-## :black_nib: Code of Conduct
-
-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.**
-
-## :black_nib: References
-
-If you are using **vantage6**, please cite this repository as well as the accompanying papers as follows:
-
-> - F. Martin, M. Sieswerda, H. Alradhi, et al. vantage6. Available at https://doi.org/10.5281/zenodo.7221216. Accessed on MONTH, 20XX.
-> - 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/)]
-> - 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)]
-
----
-
-<p align="center">
-  <a href="https://vantage6.ai">vantage6.ai</a> •
-  <a href="https://discord.gg/yAyFf6Y">Discord</a> •
-  <a href="https://vantage6.discourse.group/">Discourse</a> •
-  <a href="https://docs.vantage6.ai">User documentation</a>
-</p>

vantage6-5.0.0a26.dist-info/entry_points.txt

@@ -1,5 +0,0 @@
-[console_scripts]
-v6 = vantage6.cli.cli:cli_complete
-vdev = vantage6.cli.cli:cli_dev
-vnode = vantage6.cli.cli:cli_node
-vserver = vantage6.cli.cli:cli_server

vantage6-5.0.0a26.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-tests_cli
-vantage6