fix: moved from typer to click to enable passing args to docker image

Author: Integer-Ctrl

Dockerfile

@@ -1,12 +1,11 @@
-FROM python:3.11-slim
+FROM python:3.10-slim
 
 WORKDIR /app
 
-# Copy everything first (pyproject.toml, README.md, and source code)
 COPY . .
 
-# Install the package + dependencies
+# Install dependencies
 RUN pip install .
 
-# Default command
-ENTRYPOINT ["python", "-m", "databusclient"]
+# Use ENTRYPOINT for the CLI
+ENTRYPOINT ["databusclient"]

databusclient/cli.py

@@ -1,49 +1,112 @@
+# TODO: Typer did not work in Docker container, meaning passed arguments were ignored. Switch to Click for now. Decide later if we want to switch back to Typer.
+# # !/usr/bin/env python3
+# import typer
+# from typing import List
+# from databusclient import client
+
+# app = typer.Typer()
+
+
+# @app.command()
+# def deploy(
+#     version_id: str = typer.Option(
+#         ...,
+#         help="target databus version/dataset identifier of the form "
+#         "<https://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VERSION>",
+#     ),
+#     title: str = typer.Option(..., help="dataset title"),
+#     abstract: str = typer.Option(..., help="dataset abstract max 200 chars"),
+#     description: str = typer.Option(..., help="dataset description"),
+#     license_uri: str = typer.Option(..., help="license (see dalicc.net)"),
+#     apikey: str = typer.Option(..., help="apikey"),
+#     distributions: List[str] = typer.Argument(
+#         ...,
+#         help="distributions in the form of List[URL|CV|fileext|compression|sha256sum:contentlength] where URL is the "
+#         "download URL and CV the "
+#         "key=value pairs (_ separated) content variants of a distribution. filext and compression are optional "
+#         "and if left out inferred from the path. If the sha256sum:contentlength part is left out it will be "
+#         "calcuted by downloading the file.",
+#     ),
+# ):
+#     typer.echo(version_id)
+#     dataid = client.create_dataset(
+#         version_id, title, abstract, description, license_uri, distributions
+#     )
+#     client.deploy(dataid=dataid, api_key=apikey)
+
+
+# @app.command()
+# def download(
+#     databusuris: List[str] = typer.Argument(..., help="any kind of these: databus identifier, databus collection identifier, query file"),
+#     localDir: str = typer.Option(None , help="local databus folder"), # if not given, databus folder structure is created in current working directory
+#     databus: str = typer.Option(None, help="databus URL"), # if not given, inferred on databusuri (e.g. https://databus.dbpedia.org/sparql)
+#     token: str = typer.Option(None, help="Path to Vault refresh token file"),
+#     authUrl: str = typer.Option("https://auth.dbpedia.org/realms/dbpedia/protocol/openid-connect/token", help="Keycloak token endpoint URL"),
+#     clientId: str = typer.Option("vault-token-exchange", help="Client ID for token exchange")
+# ):
+#     """
+#     Download datasets from databus, optionally using vault access if vault options are provided.
+#     """
+#     client.download(localDir=localDir, endpoint=databus, databusURIs=databusuris, vault_token_file=vaultTokenFile, auth_url=authUrl, client_id=clientId)
+
 #!/usr/bin/env python3
-import typer
+import click
 from typing import List
 from databusclient import client
 
-app = typer.Typer()
+
+@click.group()
+def app():
+    """Databus Client CLI"""
+    pass
 
 
 @app.command()
-def deploy(
-    version_id: str = typer.Option(
-        ...,
-        help="target databus version/dataset identifier of the form "
-        "<https://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VERSION>",
-    ),
-    title: str = typer.Option(..., help="dataset title"),
-    abstract: str = typer.Option(..., help="dataset abstract max 200 chars"),
-    description: str = typer.Option(..., help="dataset description"),
-    license_uri: str = typer.Option(..., help="license (see dalicc.net)"),
-    apikey: str = typer.Option(..., help="apikey"),
-    distributions: List[str] = typer.Argument(
-        ...,
-        help="distributions in the form of List[URL|CV|fileext|compression|sha256sum:contentlength] where URL is the "
-        "download URL and CV the "
-        "key=value pairs (_ separated) content variants of a distribution. filext and compression are optional "
-        "and if left out inferred from the path. If the sha256sum:contentlength part is left out it will be "
-        "calcuted by downloading the file.",
-    ),
-):
-    typer.echo(version_id)
-    dataid = client.create_dataset(
-        version_id, title, abstract, description, license_uri, distributions
-    )
+@click.option(
+    "--version-id",
+    required=True,
+    help="Target databus version/dataset identifier of the form "
+         "<https://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VERSION>",
+)
+@click.option("--title", required=True, help="Dataset title")
+@click.option("--abstract", required=True, help="Dataset abstract max 200 chars")
+@click.option("--description", required=True, help="Dataset description")
+@click.option("--license-uri", required=True, help="License (see dalicc.net)")
+@click.option("--apikey", required=True, help="API key")
+@click.argument(
+    "distributions",
+    nargs=-1,
+    required=True,
+)
+def deploy(version_id, title, abstract, description, license_uri, apikey, distributions: List[str]):
+    """
+    Deploy a dataset version with the provided metadata and distributions.
+    """
+    click.echo(f"Deploying dataset version: {version_id}")
+    dataid = client.create_dataset(version_id, title, abstract, description, license_uri, distributions)
     client.deploy(dataid=dataid, api_key=apikey)
 
 
 @app.command()
-def download(
-    databusuris: List[str] = typer.Argument(..., help="any kind of these: databus identifier, databus collection identifier, query file"),
-    localDir: str = typer.Option(None , help="local databus folder"), # if not given, databus folder structure is created in current working directory
-    databus: str = typer.Option(None, help="databus URL"), # if not given, inferred on databusuri (e.g. https://databus.dbpedia.org/sparql)
-    token: str = typer.Option(None, help="Path to Vault refresh token file"),
-    authUrl: str = typer.Option("https://auth.dbpedia.org/realms/dbpedia/protocol/openid-connect/token", help="Keycloak token endpoint URL"),
-    clientId: str = typer.Option("vault-token-exchange", help="Client ID for token exchange")
-):
+@click.argument("databusuris", nargs=-1, required=True)
+@click.option("--localdir", help="Local databus folder (if not given, databus folder structure is created in current working directory)")
+@click.option("--databus", help="Databus URL (if not given, inferred from databusuri, e.g. https://databus.dbpedia.org/sparql)")
+@click.option("--token", help="Path to Vault refresh token file")
+@click.option("--authurl", default="https://auth.dbpedia.org/realms/dbpedia/protocol/openid-connect/token", show_default=True, help="Keycloak token endpoint URL")
+@click.option("--clientid", default="vault-token-exchange", show_default=True, help="Client ID for token exchange")
+def download(databusuris: List[str], localdir, databus, token, authurl, clientid):
     """
     Download datasets from databus, optionally using vault access if vault options are provided.
     """
-    client.download(localDir=localDir, endpoint=databus, databusURIs=databusuris, vault_token_file=vaultTokenFile, auth_url=authUrl, client_id=clientId)
+    client.download(
+        localDir=localdir,
+        endpoint=databus,
+        databusURIs=databusuris,
+        token=token,
+        auth_url=authurl,
+        client_id=clientid,
+    )
+
+
+if __name__ == "__main__":
+    app()

databusclient/client.py

@@ -592,7 +592,7 @@ def download(
     localDir: str,
     endpoint: str,
     databusURIs: List[str],
-    vault_token_file=None,
+    token=None,
     auth_url=None,
     client_id=None
 ) -> None:
@@ -602,7 +602,7 @@ def download(
     localDir: the local directory
     endpoint: the databus endpoint URL
     databusURIs: identifiers to access databus registered datasets
-    vault_token_file: Path to Vault refresh token file
+    token: Path to Vault refresh token file
     auth_url: Keycloak token endpoint URL
     client_id: Client ID for token exchange
     """
@@ -624,12 +624,12 @@ def download(
                 __download_list__(res, localDir)
             # databus file
             elif file is not None:
-                __download_list__([databusURI], localDir, vault_token_file=vault_token_file, auth_url=auth_url, client_id=client_id)
+                __download_list__([databusURI], localDir, vault_token_file=token, auth_url=auth_url, client_id=client_id)
             # databus artifact version
             elif version is not None:
                 json_str = __handle_databus_artifact_version__(databusURI)
                 res = __handle_databus_file_json__(json_str)
-                __download_list__(res, localDir, vault_token_file=vault_token_file, auth_url=auth_url, client_id=client_id)
+                __download_list__(res, localDir, vault_token_file=token, auth_url=auth_url, client_id=client_id)
             # databus artifact
             elif artifact is not None:
                 print("artifactId not supported yet")  # TODO