vantage6 4.5.2__tar.gz → 4.13.3rc2__tar.gz

{vantage6-4.5.2 → vantage6-4.13.3rc2}/PKG-INFO

@@ -1,11 +1,34 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: vantage6
-Version: 4.5.2
+Version: 4.13.3rc2
 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.9.1
+Requires-Dist: docker==7.1.0
+Requires-Dist: ipython==8.10.0
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: pandas>=1.5.3
+Requires-Dist: questionary==2.1.1
+Requires-Dist: rich==13.5.2
+Requires-Dist: schema==0.7.5
+Requires-Dist: SQLAlchemy==1.4.46
+Requires-Dist: vantage6-common==4.13.3rc2
+Requires-Dist: vantage6-client==4.13.3rc2
 Provides-Extra: dev
+Requires-Dist: coverage==6.4.4; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <h1 align="center">
   <br>
@@ -23,6 +46,9 @@ Provides-Extra: dev
 [![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>
 
@@ -30,26 +56,39 @@ Provides-Extra: dev
   <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 (vantage6.ai)](https://vantage6.ai) to learn more!
+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 (docs.vantage6.ai)](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)](https://discord.gg/yAyFf6Y) channel.
+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 VPN network._
+_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 VPN 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).
+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:
 
@@ -85,9 +124,11 @@ v6 node attach
 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:
+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: `org_1-admin`
+- Username: `dev_admin`
 - Password: `password`
 
 For example, you can create a new organization by running:
@@ -95,8 +136,8 @@ For example, you can create a new organization by running:
 ```python
 from vantage6.client import Client
 
-client = Client('http://127.0.0.1', 5000, '/api', log_level='debug')
-client.authenticate('org_1-admin', 'password')
+client = Client('http://127.0.0.1', 7601, '/api', log_level='debug')
+client.authenticate('dev_admin', 'password')
 client.setup_encryption(None)
 
 client.organization.create(
@@ -109,7 +150,7 @@ client.organization.create(
 )
 ```
 
-You can find more (user) documentation at [readthedocs (docs.vantage6.ai)](https://docs.vantage6.ai)
+You can find more (user) documentation at [readthedocs](https://docs.vantage6.ai)
 
 ## Project structure
 
@@ -134,14 +175,16 @@ 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:
+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`.
+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:
 
@@ -159,12 +202,24 @@ And finally there are some images released for 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)
+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:
@@ -179,5 +234,5 @@ If you are using **vantage6**, please cite this repository as well as the accomp
   <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> •
+  <a href="https://docs.vantage6.ai">User documentation</a>
 </p>

{vantage6-4.5.2 → vantage6-4.13.3rc2}/setup.py

@@ -1,11 +1,11 @@
 import codecs
 import os
-
-from os import path
 from codecs import open
-from setuptools import setup, find_namespace_packages
+from os import path
 from pathlib import Path
 
+from setuptools import find_namespace_packages, setup
+
 # get current directory
 here = Path(path.abspath(path.dirname(__file__)))
 parent_dir = here.parent.absolute()
@@ -35,16 +35,17 @@ setup(
     install_requires=[
         "click==8.1.3",
         "colorama==0.4.6",
-        "copier==9.2.0",
+        "copier==9.9.1",
         "docker==7.1.0",
         "ipython==8.10.0",
-        "jinja2==3.1.4",
-        "questionary==1.10.0",
+        "jinja2==3.1.6",
+        "pandas>=1.5.3",
+        "questionary==2.1.1",
         "rich==13.5.2",
         "schema==0.7.5",
         "SQLAlchemy==1.4.46",
-        f'vantage6-common == {version_ns["__version__"]}',
-        f'vantage6-client == {version_ns["__version__"]}',
+        f"vantage6-common == {version_ns['__version__']}",
+        f"vantage6-client == {version_ns['__version__']}",
     ],
     extras_require={
         "dev": [
@@ -60,6 +61,10 @@ setup(
             "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",
         ],
     },
     entry_points={

vantage6-4.13.3rc2/tests_cli/test_client_script.py

@@ -0,0 +1,23 @@
+from click import UsageError
+from vantage6.cli.test.client_script import cli_test_client_script
+
+import click
+import unittest
+
+
+class TestScriptTest(unittest.TestCase):
+    def test_script_incorrect_usage(self):
+        ctx = click.Context(cli_test_client_script)
+
+        with self.assertRaises(UsageError):
+            ctx.invoke(
+                cli_test_client_script,
+                script="path/to/script.py",
+                task_arguments="{'my_arg': 1}",
+            )
+
+        with self.assertRaises(UsageError):
+            ctx.invoke(
+                cli_test_client_script,
+                task_arguments="not_a_json",
+            )

{vantage6-4.5.2 → vantage6-4.13.3rc2}/tests_cli/test_node_cli.py

@@ -9,6 +9,7 @@ from io import BytesIO, StringIO
 from click.testing import CliRunner
 from docker.errors import APIError
 
+from vantage6.common.globals import Ports
 from vantage6.cli.globals import APPNAME
 from vantage6.common import STRING_ENCODING
 from vantage6.cli.common.utils import print_log_worker
@@ -16,6 +17,7 @@ from vantage6.cli.node.list import cli_node_list
 from vantage6.cli.node.new import cli_node_new_configuration
 from vantage6.cli.node.files import cli_node_files
 from vantage6.cli.node.start import cli_node_start
+from vantage6.cli.node.restart import cli_node_restart
 from vantage6.cli.node.stop import cli_node_stop
 from vantage6.cli.node.attach import cli_node_attach
 from vantage6.cli.node.create_private_key import cli_node_create_private_key
@@ -84,7 +86,7 @@ class NodeCLITest(unittest.TestCase):
         )
 
     @patch("vantage6.cli.node.new.configuration_wizard")
-    @patch("vantage6.cli.node.new.check_config_writeable")
+    @patch("vantage6.cli.node.new.ensure_config_dir_writable")
     @patch("vantage6.cli.node.common.NodeContext")
     def test_new_config(self, context, permissions, wizard):
         """No error produced when creating new configuration."""
@@ -146,7 +148,7 @@ class NodeCLITest(unittest.TestCase):
         # check non-zero exit code
         self.assertEqual(result.exit_code, 1)
 
-    @patch("vantage6.cli.node.new.check_config_writeable")
+    @patch("vantage6.cli.node.new.ensure_config_dir_writable")
     @patch("vantage6.cli.node.common.NodeContext")
     def test_new_write_permissions(self, context, permissions):
         """User needs write permissions."""
@@ -207,7 +209,7 @@ class NodeCLITest(unittest.TestCase):
         self.assertNotEqual(result.exit_code, 0)
 
     @patch("docker.DockerClient.volumes")
-    @patch("vantage6.cli.node.start.pull_image")
+    @patch("vantage6.cli.node.start.pull_infra_image")
     @patch("vantage6.cli.common.decorator.get_context")
     @patch("docker.DockerClient.containers")
     @patch("vantage6.cli.node.start.check_docker_running", return_value=True)
@@ -242,19 +244,28 @@ class NodeCLITest(unittest.TestCase):
 
         runner = CliRunner()
 
+        # Should fail when starting node with non-existing database CSV file
         with runner.isolated_filesystem():
             result = runner.invoke(cli_node_start, ["--name", "some-name"])
+        self.assertEqual(result.exit_code, 1)
 
+        # now do it with a SQL database which doesn't have to be an existing file
+        ctx.databases = [{"label": "some_label", "uri": "data.db", "type": "sql"}]
+        with runner.isolated_filesystem():
+            result = runner.invoke(cli_node_start, ["--name", "some-name"])
         self.assertEqual(result.exit_code, 0)
 
+    def _setup_stop_test(self, containers):
+        container1 = MagicMock()
+        container1.name = f"{APPNAME}-iknl-user"
+        containers.list.return_value = [container1]
+
     @patch("docker.DockerClient.containers")
     @patch("vantage6.cli.node.stop.check_docker_running", return_value=True)
     @patch("vantage6.cli.node.stop.NodeContext")
     @patch("vantage6.cli.node.stop.delete_volume_if_exists")
     def test_stop(self, delete_volume, node_context, check_docker, containers):
-        container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-user"
-        containers.list.return_value = [container1]
+        self._setup_stop_test(containers)
 
         runner = CliRunner()
 
@@ -266,6 +277,24 @@ class NodeCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 0)
 
+    @patch("docker.DockerClient.containers")
+    @patch("vantage6.cli.node.stop.check_docker_running", return_value=True)
+    @patch("vantage6.cli.node.stop.NodeContext")
+    @patch("vantage6.cli.node.stop.delete_volume_if_exists")
+    @patch("vantage6.cli.node.restart.subprocess.run")
+    def test_restart(
+        self, subprocess_run, delete_volume, node_context, check_docker, containers
+    ):
+        """Restart a node without errors."""
+        self._setup_stop_test(containers)
+        # The subprocess.run() function is called with the command to start the node.
+        # Unfortunately it is hard to test this, so we just return a successful run
+        subprocess_run.return_value = MagicMock(returncode=0)
+        runner = CliRunner()
+        with runner.isolated_filesystem():
+            result = runner.invoke(cli_node_restart, ["--name", "iknl"])
+        self.assertEqual(result.exit_code, 0)
+
     @patch("vantage6.cli.node.attach.time")
     @patch("vantage6.cli.node.attach.print_log_worker")
     @patch("docker.DockerClient.containers")
@@ -408,7 +437,11 @@ class NodeCLITest(unittest.TestCase):
     @patch("vantage6.cli.node.common.q")
     def test_client(self, q, client, error, debug, info):
         ctx = MagicMock(
-            config={"server_url": "localhost", "port": 5000, "api_path": ""}
+            config={
+                "server_url": "localhost",
+                "port": Ports.DEV_SERVER.value,
+                "api_path": "",
+            }
         )
 
         # should not trigger an exception

{vantage6-4.5.2 → vantage6-4.13.3rc2}/tests_cli/test_server_cli.py

@@ -18,7 +18,7 @@ class ServerCLITest(unittest.TestCase):
     @patch("vantage6.cli.server.start.NetworkManager")
     @patch("vantage6.cli.server.start.docker.types.Mount")
     @patch("os.makedirs")
-    @patch("vantage6.cli.server.start.pull_image")
+    @patch("vantage6.cli.server.start.pull_infra_image")
     @patch("vantage6.cli.common.decorator.get_context")
     @patch("vantage6.cli.server.start.docker.from_env")
     @patch("vantage6.cli.common.start.check_docker_running", return_value=True)
@@ -112,7 +112,7 @@ class ServerCLITest(unittest.TestCase):
         self.assertEqual(result.exit_code, 0)
 
     @patch("vantage6.cli.server.new.configuration_wizard")
-    @patch("vantage6.cli.server.new.check_config_writeable")
+    @patch("vantage6.cli.server.new.ensure_config_dir_writable")
     @patch("vantage6.cli.server.new.ServerContext")
     def test_new(self, context, permissions, wizard):
         """New configuration without errors."""
@@ -132,7 +132,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()
@@ -146,7 +146,7 @@ class ServerCLITest(unittest.TestCase):
     def test_attach(self, containers, sleep):
         """Attach log to the console without errors."""
         container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
+        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER.value}"
         containers.list.return_value = [container1]
 
         sleep.side_effect = KeyboardInterrupt("Boom!")

{vantage6-4.5.2 → vantage6-4.13.3rc2}/tests_cli/test_wizard.py

@@ -9,7 +9,7 @@ from vantage6.cli.configuration_wizard import (
     configuration_wizard,
     select_configuration_questionaire,
 )
-from vantage6.common.globals import InstanceType
+from vantage6.common.globals import InstanceType, NodePolicy
 
 module_path = "vantage6.cli.configuration_wizard"
 
@@ -33,14 +33,20 @@ class WizardTest(unittest.TestCase):
         """An error is printed when docker is not running"""
 
         with patch(f"{module_path}.q") as q:
-            q.prompt.side_effect = self.prompts
-            q.confirm.return_value.ask.side_effect = [
+            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
@@ -61,7 +67,10 @@ class WizardTest(unittest.TestCase):
         ]
         for key in keys:
             self.assertIn(key, config)
-        nested_keys = [["policies", "allowed_algorithms"]]
+        nested_keys = [
+            ["policies", NodePolicy.ALLOWED_ALGORITHMS],
+            ["policies", NodePolicy.ALLOWED_ALGORITHM_STORES],
+        ]
         for nesting in nested_keys:
             current_config = config
             for key in nesting:
@@ -70,8 +79,8 @@ class WizardTest(unittest.TestCase):
 
     def test_server_wizard(self):
         with patch(f"{module_path}.q") as q:
-            q.prompt.side_effect = self.prompts
-            q.confirm.return_value.ask.side_effect = [
+            q.unsafe_prompt.side_effect = self.prompts
+            q.confirm.return_value.unsafe_ask.side_effect = [
                 True,
                 True,
                 True,
@@ -125,7 +134,7 @@ class WizardTest(unittest.TestCase):
         available_configurations.return_value = [[config], []]
 
         with patch(f"{module_path}.q") as q:
-            q.select.return_value.ask.return_value = "vtg6"
+            q.select.return_value.unsafe_ask.return_value = "vtg6"
             name = select_configuration_questionaire(InstanceType.NODE, True)
 
         self.assertEqual(name, "vtg6")

vantage6-4.13.3rc2/vantage6/cli/__build__

@@ -0,0 +1 @@
+2

vantage6-4.13.3rc2/vantage6/cli/__init__.py

@@ -0,0 +1,3 @@
+"""Command line interface for the vantage6 infrastructure."""
+
+from ._version import version_info, __version__  # noqa: F401

{vantage6-4.5.2 → vantage6-4.13.3rc2}/vantage6/cli/_version.py

@@ -7,7 +7,7 @@ with open(os.path.join(here, "__build__")) as fp:
     __build__ = json.load(fp)
 
 # Module version
-version_info = (4, 5, 2, "final", __build__, 0)
+version_info = (4, 13, 3, "candidate", __build__, 0)
 
 # Module version stage suffix map
 _specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}

vantage6-4.13.3rc2/vantage6/cli/algorithm/create.py

@@ -0,0 +1,193 @@
+import os
+import re
+import subprocess
+from pathlib import Path
+
+import click
+import questionary as q
+from copier import run_copy
+
+from vantage6.common import error, warning
+
+from vantage6.cli import __version__
+from vantage6.cli.globals import ALGORITHM_TEMPLATE_REPO
+from vantage6.cli.utils import info
+
+
+@click.command()
+@click.option(
+    "-n", "--name", default=None, type=str, help="Name for your new algorithm"
+)
+@click.option(
+    "-d",
+    "--dir",
+    "directory",
+    default=None,
+    type=str,
+    help="Directory to put the algorithm into",
+)
+@click.option(
+    "--major-version",
+    default=None,
+    type=int,
+    help="Major version of the algorithm. By default, the current version is used.",
+)
+def cli_algorithm_create(name: str, directory: str, major_version: int | None) -> dict:
+    """Creates a personalized template for a new algorithm
+
+    By answering a number of questions, a template will be created that will
+    simplify the creation of a new algorithm. The goal is that the algorithm
+    developer only focuses on the algorithm code rather than fitting it to
+    the vantage6 infrastructure.
+
+    The created template will contain a Python package with a Dockerfile that
+    can be used to build an appropriate Docker image that can be used as a
+    vantage6 algorithm.
+    """
+    latest_tag_of_desired_major_version = None
+    if major_version is None:
+        major_version = int(__version__.split(".")[0])
+    latest_tag_of_desired_major_version = _get_latest_major_tag(major_version)
+
+    try:
+        name, directory = _get_user_input(name, directory)
+    except KeyboardInterrupt:
+        info("Aborted by user!")
+        return
+
+    # Create the template. The `unsafe` flag is used to allow running a Python script
+    # after creating the template that cleans up some things.
+    run_copy(
+        ALGORITHM_TEMPLATE_REPO,
+        directory,
+        data={"algorithm_name": name},
+        unsafe=True,
+        vcs_ref=latest_tag_of_desired_major_version,
+    )
+    info("Template created!")
+    info(f"You can find your new algorithm in: {directory}")
+
+
+def _get_user_input(name: str, directory: str) -> None:
+    """Get user input for the algorithm creation
+
+    Parameters
+    ----------
+    name : str
+        Name for the new algorithm
+    directory : str
+        Directory to put the algorithm into
+    """
+    if not name:
+        name = q.text("Name of your new algorithm:").unsafe_ask()
+
+    if not directory:
+        default_dir = str(Path(os.getcwd()) / name)
+        directory = q.text(
+            "Directory to put the algorithm in:", default=default_dir
+        ).unsafe_ask()
+    return name, directory
+
+
+def _get_latest_major_tag(major_version: int) -> str | None:
+    """Get the latest tag for the given major version"""
+    # get the tags from the algorithm template repository
+    try:
+        tags = _get_algo_template_tags(ALGORITHM_TEMPLATE_REPO)
+    except Exception as e:
+        error(f"Failed to fetch tags from {ALGORITHM_TEMPLATE_REPO}: {e}")
+        warning("Will use latest version instead.")
+        return None
+    # Filter tags for the given major version (e.g. 5.x.x)
+    tags_in_desired_major_version = [
+        tag
+        for tag in tags
+        if tag.startswith(f"{major_version}.")
+        and re.match(rf"^{major_version}\.\d+\.\d+", tag)
+    ]
+
+    # sort the tags in descending order
+    tags_in_desired_major_version.sort(key=lambda s: _gen_sort_key(s), reverse=True)
+    return _first_non_prerelease_tag(tags_in_desired_major_version)
+
+
+def _first_non_prerelease_tag(tags: list[str]) -> str:
+    """Return the first non-prerelease tag from a list of tags"""
+    for tag in tags:
+        patch = tag.split(".")[2]
+        try:
+            int(patch)
+            return tag
+        except ValueError:
+            continue
+    # no non-prerelease tag found - return first in the list (sorted in descending
+    # order)
+    return tags[0] if tags else None
+
+
+def _gen_sort_key(tag: str) -> list[int]:
+    """Generate a sort key for a tag"""
+    major = int(tag.split(".")[0])
+    minor = int(tag.split(".")[1])
+    # Note: patch is not cast to int for sorting, because it may contain
+    # alpha/beta/rc suffixes
+    # TODO this will go wrong in sorting 1.2.13a1 vs 1.2.3a1, but we don't care
+    # about that for now, as it is unlikely that we have 10+ patch releases
+    # for the algorithm template repository
+    patch = tag.split(".")[2]
+    return [major, minor, patch]
+
+
+def _get_algo_template_tags(repo_url: str) -> list[str]:
+    """Get all tags from a git repository
+
+    Parameters
+    ----------
+    repo_url : str
+        Repository URL in format like "gh:owner/repo.git" or full git URL
+
+    Returns
+    -------
+    list[str]
+        List of tag names (without refs/tags/ prefix)
+    """
+    # Convert copier format (gh:owner/repo.git) to git URL
+    if repo_url.startswith("gh:"):
+        # Format: gh:owner/repo.git -> https://github.com/owner/repo.git
+        repo_path = repo_url[3:].rstrip(".git")
+        git_url = f"https://github.com/{repo_path}.git"
+    else:
+        git_url = repo_url
+
+    try:
+        # Use git ls-remote to fetch tags without cloning
+        result = subprocess.run(
+            ["git", "ls-remote", "--tags", git_url],
+            capture_output=True,
+            text=True,
+            check=True,
+            timeout=10,
+        )
+
+        # Parse output: lines look like "hash\trefs/tags/v1.0.0"
+        tags = []
+        for line in result.stdout.strip().split("\n"):
+            if line:
+                # Extract tag name from "refs/tags/tagname"
+                match = re.search(r"refs/tags/(.+)", line)
+                if match:
+                    tag = match.group(1)
+                    # Filter out ^{} suffix that git adds for annotated tags
+                    if not tag.endswith("^{}"):
+                        tags.append(tag)
+
+        return sorted(tags)
+    except subprocess.CalledProcessError as e:
+        info(f"Failed to fetch tags from {git_url}: {e}")
+        return []
+    except subprocess.TimeoutExpired:
+        info(f"Timeout while fetching tags from {git_url}")
+        return []
+    except FileNotFoundError:
+        info("git command not found. Please install git to fetch repository tags.")
+        return []