Add Connection.webeditor() for link to openEO Web Editor

Author: soxofaan

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Added `show_error_logs` argument to `cube.execute_batch()`/`job.start_and_wait()`/... to toggle the automatic printing of error logs on failure ([#505](https://github.com/Open-EO/openeo-python-client/issues/505))
+- Added `Connection.webeditor()` to build link to the openEO backend in the openEO Web Editor
 
 ### Changed
 

openeo/rest/connection.py

@@ -9,6 +9,7 @@
 import os
 import shlex
 import sys
+import urllib.parse
 import warnings
 from collections import OrderedDict
 from pathlib import Path, PurePosixPath
@@ -1967,6 +1968,18 @@ def version_info(self):
             }),
         }
 
+    def webeditor(self, *, editor_url: str = "https://editor.openeo.org/", anonymous: bool = False) -> str:
+        """
+        Generate URL to open this backend in the openEO Web Editor.
+        """
+        # TODO: add option to directly open link with `webbrowser.open()`?
+        # TODO: add option to print (or jupyter-aware display) the link instead of returning it?
+        params = {"server": self.root_url}
+        if anonymous:
+            params["discover"] = "1"
+        url = f"{editor_url}?{urllib.parse.urlencode(params)}"
+        return url
+
 
 def connect(
     url: Optional[str] = None,

tests/rest/test_connection.py

@@ -4010,3 +4010,10 @@ def test_create_job_intermediate_resultst(self, con120, dummy_backend):
                 "result": True,
             },
         }
+
+
+def test_webeditor(requests_mock):
+    requests_mock.get(API_URL, json=build_capabilities())
+    con = Connection(API_URL)
+    assert con.webeditor() == "https://editor.openeo.org/?server=https%3A%2F%2Foeo.test%2F"
+    assert con.webeditor(anonymous=True) == "https://editor.openeo.org/?server=https%3A%2F%2Foeo.test%2F&discover=1"