kleinkram 0.32.3__tar.gz → 0.33.0__tar.gz

{kleinkram-0.32.3 → kleinkram-0.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kleinkram
-Version: 0.32.3
+Version: 0.33.0
 Summary: A CLI for the ETH project kleinkram
 Project-URL: Homepage, https://github.com/leggedrobotics/kleinkram
 Project-URL: Issues, https://github.com/leggedrobotics/kleinkram/issues

{kleinkram-0.32.3 → kleinkram-0.33.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "kleinkram"
-version = "0.32.3"
+version = "0.33.0"
 description = "A CLI for the ETH project kleinkram"
 readme = "README.md"
 requires-python = ">=3.7"

{kleinkram-0.32.3 → kleinkram-0.33.0}/requirements.txt

@@ -8,4 +8,5 @@ black~=24.10.0
 requests~=2.32.3
 boto3~=1.35.45
 botocore~=1.35.45
-importlib-metadata~=8.5.0
+importlib-metadata~=8.5.0
+pyopenssl~=24.2.1

{kleinkram-0.32.3 → kleinkram-0.33.0}/src/kleinkram/endpoint/endpoint.py

@@ -4,7 +4,8 @@ from kleinkram.auth.auth import TokenFile
 
 endpoint = typer.Typer(
     name="endpoint",
-    help="Get Or Set the current endpoint",
+    help="Get Or Set the current endpoint.\n\nThe endpoint is used to determine the API server to connect to"
+    "(default is the API server of https://datasets.leggedrobotics.com).",
     no_args_is_help=True,
     context_settings={"help_option_names": ["-h", "--help"]},
 )

{kleinkram-0.32.3 → kleinkram-0.33.0}/src/kleinkram/error_handling.py

@@ -13,6 +13,12 @@ ExceptionType = "typing.Type[Exception]"
 ErrorHandlingCallback = typing.Callable[[Exception], int]
 
 
+class AbortException(Exception):
+
+    def __init__(self, message: str):
+        self.message = message
+
+
 class AccessDeniedException(Exception):
 
     def __init__(self, message: str, api_error: str):
@@ -22,8 +28,9 @@ class AccessDeniedException(Exception):
 
 def not_yet_implemented_handler(e: Exception):
     console = Console(file=sys.stderr)
+    default_msg = "This feature is not yet implemented. Please check for updates or use the web interface."
     panel = Panel(
-        "This feature is not yet implemented, please check for updates.",
+        f"{default_msg}",
         title="Not Yet Implemented",
         style="yellow",
         padding=(1, 2),
@@ -105,6 +112,20 @@ def remote_down_handler(e: Exception):
     print()
 
 
+def abort_handler(e: AbortException):
+    console = Console(file=sys.stderr)
+    panel = Panel(
+        f"{e.message}",
+        title="Command Aborted",
+        style="yellow",
+        padding=(1, 2),
+        highlight=True,
+    )
+    print()
+    console.print(panel)
+    print()
+
+
 class ErrorHandledTyper(Typer):
     error_handlers: typing.Dict[ExceptionType, ErrorHandlingCallback] = {
         NotAuthenticatedException: not_authenticated_handler,
@@ -114,6 +135,7 @@ class ErrorHandledTyper(Typer):
         ValueError: value_error_handler,
         RemoteProtocolError: remote_down_handler,
         ReadError: remote_down_handler,
+        AbortException: abort_handler,
     }
 
     def __init__(self, *args, **kwargs):
@@ -138,11 +160,16 @@ class ErrorHandledTyper(Typer):
                     f"An unhanded error of type {type(e).__name__} occurred.",
                     fg=typer.colors.RED,
                 )
-                typer.secho(str(e), fg=typer.colors.RED)
+
                 typer.secho(
                     " » Please report this error to the developers.",
                     fg=typer.colors.RED,
                 )
+
+                typer.secho(f"\n\n{e}:", fg=typer.colors.RED)
+                console = Console()
+                console.print_exception(show_locals=True)
+
             else:
                 self.error_handlers[type(e)](e)
 

{kleinkram-0.32.3 → kleinkram-0.33.0}/src/kleinkram/helper.py

@@ -1,20 +1,21 @@
 import glob
 import os
 import queue
+import re
+import sys
 import threading
 from datetime import datetime
 from functools import partial
 
-import typer
-from botocore.config import Config
-from botocore.utils import calculate_md5
-from typing_extensions import Dict, List
 import boto3
-
 import tqdm
+import typer
 from boto3.s3.transfer import TransferConfig
-from botocore.client import BaseClient
+from botocore.config import Config
+from botocore.utils import calculate_md5
 from rich import print
+from rich.console import Console
+from typing_extensions import Dict
 
 from kleinkram.api_client import AuthenticatedClient
 
@@ -106,84 +107,101 @@ def expand_and_match(path_pattern):
     return file_list
 
 
-def uploadFiles(files: Dict[str, str], credentials: Dict[str, str], nrThreads: int):
+def uploadFiles(
+    files_with_access: Dict[str, object], paths: Dict[str, str], nrThreads: int
+):
     client = AuthenticatedClient()
 
-    session = boto3.Session(
-        aws_access_key_id=credentials["accessKey"],
-        aws_secret_access_key=credentials["secretKey"],
-        aws_session_token=credentials["sessionToken"],
-    )
     api_endpoint = client.tokenfile.endpoint
     if api_endpoint == "http://localhost:3000":
         minio_endpoint = "http://localhost:9000"
     else:
         minio_endpoint = api_endpoint.replace("api", "minio")
 
-    config = Config(retries={"max_attempts": 10, "mode": "standard"})
-    s3 = session.resource("s3", endpoint_url=minio_endpoint, config=config)
-
     _queue = queue.Queue()
-    for file in files.items():
-        _queue.put(file)
+    for file_with_access in files_with_access:
+        _queue.put((file_with_access, str(paths[file_with_access["fileName"]])))
+
     threads = []
-    transferCallback = TransferCallback()
-    failed_uploads = []
+    transfer_callback = TransferCallback()
 
     for i in range(nrThreads):
         thread = threading.Thread(
-            target=uploadFile, args=(_queue, s3, transferCallback, failed_uploads)
+            target=uploadFile,
+            args=(_queue, minio_endpoint, transfer_callback),
         )
         thread.start()
         threads.append(thread)
     for thread in threads:
         thread.join()
-    if len(failed_uploads) > 0:
-        print("Failed to upload the following files:")
-        for file in failed_uploads:
-            print(file)
 
 
 def uploadFile(
     _queue: queue.Queue,
-    s3: BaseClient,
-    transferCallback: TransferCallback,
-    failed_uploads: List[str],
+    minio_endpoint: str,
+    transfer_callback: TransferCallback,
 ):
+    config = Config(retries={"max_attempts": 10, "mode": "standard"})
+
     while True:
         try:
-            filename, _file = _queue.get(timeout=3)
-            queueUUID = _file["queueUUID"]
-            filepath = _file["filepath"]
-            bucket = _file["bucket"]
-            target_location = _file["location"]
-            config = TransferConfig(
-                multipart_chunksize=10 * 1024 * 1024, max_concurrency=5
+            file_with_access, filepath = _queue.get(timeout=3)
+
+            if "error" in file_with_access and (
+                file_with_access["error"] is not None or file_with_access["error"] != ""
+            ):
+                console = Console(file=sys.stderr, style="red", highlight=False)
+                console.print(
+                    f"Error uploading file: {file_with_access['fileName']} ({filepath}): {file_with_access['error']}"
+                )
+                _queue.task_done()
+                continue
+
+            access_key = file_with_access["accessCredentials"]["accessKey"]
+            secret_key = file_with_access["accessCredentials"]["secretKey"]
+            session_token = file_with_access["accessCredentials"]["sessionToken"]
+
+            session = boto3.Session(
+                aws_access_key_id=access_key,
+                aws_secret_access_key=secret_key,
+                aws_session_token=session_token,
+            )
+
+            s3 = session.resource("s3", endpoint_url=minio_endpoint, config=config)
+
+            fileu_uid = file_with_access["fileUUID"]
+            bucket = file_with_access["bucket"]
+
+            transfer_config = TransferConfig(
+                multipart_chunksize=10 * 1024 * 1024,
+                max_concurrency=5,
             )
             with open(filepath, "rb") as f:
                 md5_checksum = calculate_md5(f)
                 file_size = os.path.getsize(filepath)
-                transferCallback.add_file(filename, file_size)
-                callback_function = create_transfer_callback(transferCallback, filename)
+                transfer_callback.add_file(filepath, file_size)
+                callback_function = create_transfer_callback(
+                    transfer_callback, filepath
+                )
                 s3.Bucket(bucket).upload_file(
                     filepath,
-                    target_location,
-                    Config=config,
+                    fileu_uid,
+                    Config=transfer_config,
                     Callback=callback_function,
                 )
 
                 client = AuthenticatedClient()
                 res = client.post(
                     "/queue/confirmUpload",
-                    json={"uuid": queueUUID, "md5": md5_checksum},
+                    json={"uuid": fileu_uid, "md5": md5_checksum},
                 )
                 res.raise_for_status()
             _queue.task_done()
         except queue.Empty:
             break
         except Exception as e:
-            print(f"Error uploading {filename}: {e}")
-            failed_uploads.append(filepath)
+            print("Error uploading file: " + filepath)
+            print(e)
             _queue.task_done()
 
 
@@ -235,6 +253,18 @@ def promptForTags(setTags: Dict[str, str], requiredTags: Dict[str, str]):
             setTags[required_tag["uuid"]] = tag_value
 
 
+def is_valid_UUIDv4(uuid: str) -> bool:
+    has_correct_length = len(uuid) == 36
+
+    # is UUID4
+    uuid_regex = (
+        "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+    )
+    is_valid_uuid = re.match(uuid_regex, uuid)
+
+    return has_correct_length and is_valid_uuid
+
+
 if __name__ == "__main__":
     res = expand_and_match(
         "~/Downloads/dodo_mission_2024_02_08-20240408T074313Z-003/**.bag"

kleinkram-0.33.0/src/kleinkram/main.py

@@ -0,0 +1,381 @@
+import importlib.metadata
+import os
+from datetime import datetime, timedelta
+from enum import Enum
+
+import httpx
+import typer
+from rich import print
+from rich.table import Table
+from typer.core import TyperGroup
+from typer.models import Context
+from typing_extensions import Annotated, List, Optional
+
+from kleinkram.api_client import AuthenticatedClient
+from kleinkram.auth.auth import login, setCliKey, logout
+from kleinkram.endpoint.endpoint import endpoint
+from kleinkram.error_handling import (
+    ErrorHandledTyper,
+    AccessDeniedException,
+)
+from kleinkram.file.file import file
+from kleinkram.mission.mission import missionCommands
+from kleinkram.project.project import project
+from kleinkram.queue.queue import queue
+from kleinkram.tag.tag import tag
+from kleinkram.topic.topic import topic
+from kleinkram.user.user import user
+from .helper import (
+    uploadFiles,
+    expand_and_match,
+    canUploadMission,
+    promptForTags,
+    is_valid_UUIDv4,
+)
+
+
+class CommandPanel(str, Enum):
+    CoreCommands = "CORE COMMANDS"
+    Commands = "COMMANDS"
+    AdditionalCommands = "ADDITIONAL COMMANDS"
+
+
+def version_callback(value: bool):
+    if value:
+        try:
+            _version = importlib.metadata.version("kleinkram")
+        except importlib.metadata.PackageNotFoundError:
+            _version = "local"
+        typer.echo(f"CLI Version: {_version}")
+        raise typer.Exit()
+
+
+class OrderCommands(TyperGroup):
+    """
+
+    The following code snippet is taken from https://github.com/tiangolo/typer/discussions/855 (see comment
+    https://github.com/tiangolo/typer/discussions/855#discussioncomment-9824582) and adapted to our use case.
+    """
+
+    def list_commands(self, _ctx: Context) -> List[str]:
+        order = list(CommandPanel)
+        grouped_commands = {
+            name: getattr(command, "rich_help_panel")
+            for name, command in sorted(self.commands.items())
+            if getattr(command, "rich_help_panel") in order
+        }
+        ungrouped_command_names = [
+            command.name
+            for command in self.commands.values()
+            if command.name not in grouped_commands
+        ]
+        return [
+            name
+            for name, command in sorted(
+                grouped_commands.items(),
+                key=lambda item: order.index(item[1]),
+            )
+        ] + sorted(ungrouped_command_names)
+
+
+app = ErrorHandledTyper(
+    context_settings={"help_option_names": ["-h", "--help"]},
+    no_args_is_help=True,
+    cls=OrderCommands,
+    help=f"Kleinkram CLI\n\nThe Kleinkram CLI is a command line interface for Kleinkram. "
+    f"For a list of available commands, run 'klein --help' or visit "
+    f"https://docs.datasets.leggedrobotics.com/usage/cli/cli-getting-started.html for more information.",
+)
+
+
+@app.callback()
+def version(
+    version: bool = typer.Option(
+        None,
+        "--version",
+        "-v",
+        callback=version_callback,
+        is_eager=True,
+        help="Print the version and exit",
+    )
+):
+    pass
+
+
+app.add_typer(project, rich_help_panel=CommandPanel.Commands)
+app.add_typer(missionCommands, rich_help_panel=CommandPanel.Commands)
+
+app.add_typer(topic, rich_help_panel=CommandPanel.Commands)
+app.add_typer(file, rich_help_panel=CommandPanel.Commands)
+app.add_typer(queue, rich_help_panel=CommandPanel.Commands)
+app.add_typer(user, rich_help_panel=CommandPanel.Commands)
+app.add_typer(tag, rich_help_panel=CommandPanel.Commands)
+app.add_typer(endpoint, rich_help_panel=CommandPanel.AdditionalCommands)
+
+app.command(rich_help_panel=CommandPanel.AdditionalCommands)(login)
+app.command(rich_help_panel=CommandPanel.AdditionalCommands)(logout)
+app.command(hidden=True)(setCliKey)
+
+
+@app.command("download", rich_help_panel=CommandPanel.CoreCommands)
+def download():
+    print(
+        "Not implemented yet. Consider using the 'klein file download' or 'klein mission download' commands."
+    )
+
+
+@app.command("upload", rich_help_panel=CommandPanel.CoreCommands, no_args_is_help=True)
+def upload(
+    path: Annotated[
+        List[str],
+        typer.Option(help="Path to files to upload, Regex supported"),
+    ],
+    project: Annotated[str, typer.Option(help="Name or UUID of a Project")],
+    mission: Annotated[str, typer.Option(help="Name of UUID Mission to create")],
+    tags: Annotated[
+        Optional[List[str]],
+        typer.Option(help="Tags to add to the mission"),
+    ] = None,
+    fix_filenames: Annotated[
+        bool,
+        typer.Option(help="Automatically fix filenames such that they are valid"),
+    ] = False,
+    create_project: Annotated[
+        bool,
+        typer.Option(help="Allows adding files to an existing mission"),
+    ] = False,
+    create_mission: Annotated[
+        bool,
+        typer.Option(help="Allows adding files to an existing mission"),
+    ] = False,
+):
+    """
+    Upload files matching the path to a mission in a project.
+
+    The mission name must be unique within the project and not yet created.\n
+    Multiple paths can be given by using the option multiple times.\n
+    Examples:\n
+        - 'klein upload --path "~/data/**/*.bag" --project "Project 1" --mission "Mission 1" --tags "0700946d-1d6a-4520-b263-0e177f49c35b:LEE-H" --tags "1565118d-593c-4517-8c2d-9658452d9319:Dodo"'\n
+
+    """
+
+    client = AuthenticatedClient()
+
+    ##############################
+    # Check if project exists
+    ##############################
+    if is_valid_UUIDv4(project):
+        get_project_url = "/project/one"
+        project_response = client.get(get_project_url, params={"uuid": project})
+    else:
+        get_project_url = "/project/byName"
+        project_response = client.get(get_project_url, params={"name": project})
+
+    if project_response.status_code >= 400:
+        if not create_project and not is_valid_UUIDv4(project):
+            raise AccessDeniedException(
+                f"The project '{project}' does not exist or you do not have access to it.\n"
+                f"Consider using the following command to create a project: 'klein project create' "
+                f"or consider passing the flag '--create-project' to create the project automatically.",
+                f"{project_response.json()['message']} ({project_response.status_code})",
+            )
+        elif is_valid_UUIDv4(project):
+            raise ValueError(
+                f"Project '{project}' does not exist. UUIDs cannot be used to create projects.\n"
+                f"Please provide a valid project name or consider creating the project using the"
+                f" following command: 'klein project create'"
+            )
+        else:
+            print(f"Project '{project}' does not exist. Creating it now.")
+            create_project_url = "/project/create"
+            project_response = client.post(
+                create_project_url,
+                json={
+                    "name": project,
+                    "description": "Autogenerated by klein CLI",
+                    "requiredTags": [],
+                },
+            )
+            if project_response.status_code >= 400:
+                raise ValueError(
+                    f"Failed to create project. Status Code: "
+                    f"{str(project_response.status_code)}\n"
+                    f"{project_response.json()['message'][0]}"
+                )
+            print("Project created successfully.")
+
+    project_json = project_response.json()
+    if not project_json["uuid"]:
+        print(f"Project not found: '{project}'")
+        return
+
+    can_upload = canUploadMission(client, project_json["uuid"])
+    if not can_upload:
+        raise AccessDeniedException(
+            f"You do not have the required permissions to upload to project '{project}'\n",
+            "Access Denied",
+        )
+
+    if not tags:
+        tags = []
+    tags_dict = {item.split(":")[0]: item.split(":")[1] for item in tags}
+
+    required_tags = (
+        project_json["requiredTags"] if "requiredTags" in project_json else []
+    )
+    promptForTags(tags_dict, required_tags)
+
+    ##############################
+    # Check if mission exists
+    ##############################
+    if is_valid_UUIDv4(mission):
+        get_mission_url = "/mission/one"
+        mission_response = client.get(get_mission_url, params={"uuid": mission})
+    else:
+        get_mission_url = "/mission/byName"
+        mission_response = client.get(get_mission_url, params={"name": mission})
+
+    if mission_response.status_code >= 400:
+        if not create_mission:
+            raise AccessDeniedException(
+                f"The mission '{mission}' does not exist or you do not have access to it.\n"
+                f"Consider using the following command to create a mission: 'klein mission create' "
+                f"or consider passing the flag '--create-mission' to create the mission automatically.",
+                f"{mission_response.json()['message']} ({mission_response.status_code})",
+            )
+        else:
+            print(f"Mission '{mission}' does not exist. Creating it now.")
+            create_mission_url = "/mission/create"
+            mission_response = client.post(
+                create_mission_url,
+                json={
+                    "name": mission,
+                    "projectUUID": project_json["uuid"],
+                    "tags": tags_dict,
+                },
+            )
+            if mission_response.status_code >= 400:
+                raise ValueError(
+                    f"Failed to create mission. Status Code: "
+                    f"{str(mission_response.status_code)}\n"
+                    f"{mission_response.json()['message'][0]}"
+                )
+
+    mission_json = mission_response.json()
+
+    files = []
+    for p in path:
+        files.extend(expand_and_match(p))
+
+    print(
+        f"Uploading the following files to mission '{mission_json['name']}' in project '{project_json['name']}':"
+    )
+    filename_filepaths_map = {}
+    for path in files:
+        if not os.path.isdir(path):
+
+            filename = path.split("/")[-1]
+            filename_without_extension, extension = os.path.splitext(filename)
+            if fix_filenames:
+
+                # replace all non-alphanumeric characters with underscores
+                filename_without_extension = "".join(
+                    char if char.isalnum() else "_"
+                    for char in filename_without_extension
+                )
+
+                # trim filename to 40 characters
+                filename_without_extension = filename_without_extension[:40]
+                filename = f"{filename_without_extension}{extension}"
+
+            if (
+                not filename.replace(".", "")
+                .replace("_", "")
+                .replace("-", "")
+                .isalnum()
+            ):
+                raise ValueError(
+                    f"Filename '{filename}' is not valid. It must only contain alphanumeric characters, underscores and "
+                    f"hyphens. Consider using the '--fix-filenames' option to automatically fix the filenames."
+                )
+
+            if not 3 <= len(filename_without_extension) <= 40:
+                raise ValueError(
+                    f"Filename '{filename}' is not valid. It must be between 3 and 40 characters long. Consider using "
+                    f"the '--fix-filenames' option to automatically fix the filenames."
+                )
+
+            filename_filepaths_map[filename] = path
+            typer.secho(f" - {filename}", fg=typer.colors.RESET)
+    print("\n\n")
+
+    filenames = list(filename_filepaths_map.keys())
+
+    if not filenames:
+        raise ValueError("No files found matching the given path.")
+
+    # validate filenames
+    if len(filenames) != len(set(filenames)):
+        raise ValueError(
+            "Filenames must be unique. Please check the files you are trying to upload. This can happen if you have "
+            "multiple files with the same name in different directories or use the '--fix-filenames' option."
+        )
+
+    get_temporary_credentials = "/file/temporaryAccess"
+    response = client.post(
+        get_temporary_credentials,
+        json={"filenames": filenames, "missionUUID": mission_json["uuid"]},
+    )
+    if response.status_code >= 400:
+        raise ValueError(
+            "Failed to get temporary credentials. Status Code: "
+            + str(response.status_code)
+            + "\n"
+            + response.json()["message"][0]
+        )
+
+    uploadFiles(response.json(), filename_filepaths_map, 4)
+
+
+@queue.command("list")
+def list_queue():
+    """List current Queue entities"""
+    try:
+        url = "/queue/active"
+        startDate = datetime.now().date() - timedelta(days=1)
+        client = AuthenticatedClient()
+        response = client.get(url, params={"startDate": startDate})
+        response.raise_for_status()
+        data = response.json()
+        table = Table("UUID", "filename", "mission", "state", "origin", "createdAt")
+        for topic in data:
+            table.add_row(
+                topic["uuid"],
+                topic["filename"],
+                topic["mission"]["name"],
+                topic["state"],
+                topic["location"],
+                topic["createdAt"],
+            )
+        print(table)
+
+    except httpx.HTTPError as e:
+        print(e)
+
+
+@app.command("claim", hidden=True)
+def claim():
+    """
+    Claim admin rights as the first user
+
+    Only works if no other user has claimed admin rights before.
+    """
+
+    client = AuthenticatedClient()
+    response = client.post("/user/claimAdmin")
+    response.raise_for_status()
+    print("Admin claimed.")
+
+
+if __name__ == "__main__":
+    app()

{kleinkram-0.32.3 → kleinkram-0.33.0}/src/kleinkram/mission/mission.py

@@ -1,13 +1,13 @@
 import os
-
-from botocore.utils import calculate_md5
-from typing_extensions import Annotated, Optional, List
+import re
 
 import httpx
 import requests
 import typer
 from rich.console import Console
 from rich.table import Table
+from tqdm import tqdm
+from typing_extensions import Annotated, Optional, List
 
 from kleinkram.api_client import AuthenticatedClient
 from kleinkram.error_handling import AccessDeniedException
@@ -143,15 +143,20 @@ def mission_by_uuid(
 
     if json:
         print(data)
-    else:
-        print(f"mission: {data['name']}")
-        print(f"Creator: {data['creator']['name']}")
-        print("Project: " + data["project"]["name"])
-        table = Table("Filename", "Size", "date")
-        for file in data["files"]:
-            table.add_row(file["filename"], f"{file['size']}", file["date"])
-        console = Console()
-        console.print(table)
+        return
+    print(f"mission: {data['name']}")
+    print(f"Creator: {data['creator']['name']}")
+    print("Project: " + data["project"]["name"])
+    table = Table("Filename", "Size", "date")
+
+    if "files" not in data:
+        print("No files found for mission.")
+        return
+
+    for file in data["files"]:
+        table.add_row(file["filename"], f"{file['size']}", file["date"])
+    console = Console()
+    console.print(table)
 
 
 @missionCommands.command("download")
@@ -160,6 +165,11 @@ def download(
         List[str], typer.Option(help="UUIDs of Mission to download")
     ],
     local_path: Annotated[str, typer.Option()],
+    pattern: Optional[str] = typer.Option(
+        None,
+        help="Simple pattern to match the filename against. Allowed are alphanumeric characters,"
+        " '_', '-', '.' and '*' as wildcard.",
+    ),
 ):
     """
 
@@ -171,7 +181,13 @@ def download(
     if not os.path.isdir(local_path):
         raise ValueError(f"Local path '{local_path}' is not a directory.")
     if not os.listdir(local_path) == []:
-        raise ValueError(f"Local path '{local_path}' is not empty, but must be empty.")
+
+        full_local_path = os.path.abspath(local_path)
+
+        raise ValueError(
+            f"Local path '{full_local_path}' is not empty, it contains {len(os.listdir(local_path))} files. "
+            f"The local target directory must be empty."
+        )
 
     client = AuthenticatedClient()
     for single_mission_uuid in mission_uuid:
@@ -189,20 +205,43 @@ def download(
         if len(paths) == 0:
             continue
 
+        # validate search pattern
+        if pattern:
+            if not re.match(r"^[a-zA-Z0-9_\-.*]+$", pattern):
+                raise ValueError(
+                    "Invalid pattern. Allowed are alphanumeric characters, '_', '-', '.' and '*' as wildcard."
+                )
+
+            regex = pattern.replace("*", ".*")
+            pattern = re.compile(regex)
+
+        print(f"Found {len(paths)} files in mission:")
+        paths = [
+            path for path in paths if not pattern or pattern.match(path["filename"])
+        ]
+
+        if pattern:
+            print(
+                f" » filtered to {len(paths)} files matching pattern '{pattern.pattern}'."
+            )
+
+        print(f"Start downloading {len(paths)} files to '{local_path}':\n")
         for path in paths:
 
             filename = path["filename"]
-            print(f" - {filename}")
 
             response = requests.get(path["link"], stream=True)  # Enable streaming mode
-            chunk_size = 1024 * 100  # 100 KB chunks, adjust size if needed
+            chunk_size = 1024 * 1024 * 10  # 10 MB chunks, adjust size if needed
 
             # Open the file for writing in binary mode
             with open(os.path.join(local_path, filename), "wb") as f:
-                for chunk in response.iter_content(chunk_size=chunk_size):
+                for chunk in tqdm(
+                    response.iter_content(chunk_size=chunk_size),
+                    unit="MB",
+                    desc=filename,
+                ):
                     if chunk:  # Filter out keep-alive new chunks
                         f.write(chunk)
-                print(f"   Downloaded {filename}")
 
 
 @missionCommands.command("upload")

kleinkram-0.33.0/src/kleinkram/project/project.py

@@ -0,0 +1,138 @@
+import httpx
+import typer
+from rich.console import Console
+from rich.table import Table
+from typing_extensions import Annotated
+
+from kleinkram.api_client import AuthenticatedClient
+
+project = typer.Typer(
+    name="project",
+    help="Project operations",
+    no_args_is_help=True,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+@project.command("list", help="List all projects")
+def list_projects():
+    """
+    List all projects.
+    """
+    client = AuthenticatedClient()
+    response = client.get("/project/filtered")
+    response.raise_for_status()
+    projects = response.json()[0]
+
+    if len(projects) == 0:
+        print("No projects found. Create a new project using 'klein project create'")
+        return
+
+    stdout_console = Console(stderr=False)
+    stderr_console = Console(stderr=True)
+    stderr_console.print(f"\nfound {len(projects)} projects with the following UUIDs:")
+
+    # print the uuids to stdout for simple piping
+    for p in projects:
+        stderr_console.print(" - ", end="")
+        stdout_console.print(p["uuid"])
+    stderr_console.print("\n")
+
+    # Print a summary table using rich to stderr
+    table = Table(title="Projects", expand=True)
+    table.add_column("Project UUID", width=10)
+    table.add_column("Project Name", width=12)
+    table.add_column("Description")
+    for p in projects:
+        table.add_row(p["uuid"], p["name"], p["description"])
+
+    stderr_console.print(table)
+    stderr_console.print("\n")
+
+
+@project.command("details", help="Get details of a project", no_args_is_help=True)
+def project_details(
+    project_uuid: Annotated[
+        str, typer.Argument(help="UUID of the project to get details of")
+    ]
+):
+    """
+    Get details of a project
+    """
+    client = AuthenticatedClient()
+    response = client.get(f"/project/one?uuid={project_uuid}")
+    response.raise_for_status()
+    project = response.json()
+
+    stdout_console = Console(stderr=False)
+    stderr_console = Console(stderr=True)
+    stderr_console.print(
+        f"\nDetails of project with UUID {project_uuid}:", highlight=False
+    )
+
+    # Print the details to stderr using rich
+    table = Table(title="Project Details", expand=True)
+    table.add_column("Key", width=16)
+    table.add_column("Value")
+    for key, value in project.items():
+
+        access_name_map = {0: "READ", 10: "CREATE", 20: "WRITE", 30: "DELETE"}
+
+        if key == "project_accesses":
+            value = ", ".join(
+                [
+                    f"'{access['accessGroup']['name']}' ({access_name_map[access['rights']]})"
+                    for access in value
+                ]
+            )
+
+        if key == "missions":
+            value = ", ".join([f"'{mission['name']}'" for mission in value])
+
+        if key == "creator":
+            value = value["name"]
+
+        table.add_row(key, f"{value}")
+
+    stderr_console.print(table)
+    stderr_console.print("\nList of missions:")
+    for mission in project["missions"]:
+        stderr_console.print(" - ", end="")
+        stdout_console.print(mission["uuid"])
+
+
+@project.command("create", no_args_is_help=True, help="Create a new project")
+def create_project(
+    name: Annotated[str, typer.Option(help="Name of Project")],
+    description: Annotated[str, typer.Option(help="Description of Project")],
+):
+    """
+    Create a new project
+    """
+    # Todo add required tags as option.
+    try:
+        url = "/project/create"
+        client = AuthenticatedClient()
+        response = client.post(
+            url, json={"name": name, "description": description, "requiredTags": []}
+        )  # TODO: Add required tags as option
+        if response.status_code >= 400:
+            response_json = response.json()
+            response_text = response_json["message"]
+            raise ValueError(f"Failed to create project\n » {response_text}!")
+
+        stderr_console = Console(stderr=True)
+        stderr_console.print(f"Project '{name}' created successfully.")
+
+        stdout_console = Console(stderr=False)
+        stderr_console.print("\nProject UUID:\n - ", end="")
+        stdout_console.print(response.json()["uuid"])
+
+    except httpx.HTTPError as e:
+        print(f"Failed to create project: {e}")
+        raise e
+
+
+@project.command("delete", help="Delete a project")
+def delete_project():
+    raise NotImplementedError()

kleinkram-0.32.3/src/kleinkram/main.py

@@ -1,284 +0,0 @@
-import os
-from datetime import datetime, timedelta
-from enum import Enum
-
-import httpx
-import importlib.metadata
-import typer
-from rich import print
-from rich.table import Table
-from typer.core import TyperGroup
-from typer.models import Context
-from typing_extensions import Annotated, List, Optional
-
-from kleinkram.api_client import AuthenticatedClient
-from kleinkram.auth.auth import login, setCliKey, logout
-from kleinkram.endpoint.endpoint import endpoint
-from kleinkram.error_handling import ErrorHandledTyper, AccessDeniedException
-from kleinkram.file.file import file
-from kleinkram.mission.mission import missionCommands
-from kleinkram.project.project import project
-from kleinkram.queue.queue import queue
-from kleinkram.tag.tag import tag
-from kleinkram.topic.topic import topic
-from kleinkram.user.user import user
-from .helper import uploadFiles, expand_and_match, canUploadMission, promptForTags
-
-
-class CommandPanel(str, Enum):
-    CoreCommands = "CORE COMMANDS"
-    Commands = "COMMANDS"
-    AdditionalCommands = "ADDITIONAL COMMANDS"
-
-
-def version_callback(value: bool):
-    if value:
-        try:
-            _version = importlib.metadata.version("kleinkram")
-        except importlib.metadata.PackageNotFoundError:
-            _version = "local"
-        typer.echo(f"CLI Version: {_version}")
-        raise typer.Exit()
-
-
-class OrderCommands(TyperGroup):
-    """
-
-    The following code snippet is taken from https://github.com/tiangolo/typer/discussions/855 (see comment
-    https://github.com/tiangolo/typer/discussions/855#discussioncomment-9824582) and adapted to our use case.
-    """
-
-    def list_commands(self, _ctx: Context) -> List[str]:
-        order = list(CommandPanel)
-        grouped_commands = {
-            name: getattr(command, "rich_help_panel")
-            for name, command in sorted(self.commands.items())
-            if getattr(command, "rich_help_panel") in order
-        }
-        ungrouped_command_names = [
-            command.name
-            for command in self.commands.values()
-            if command.name not in grouped_commands
-        ]
-        return [
-            name
-            for name, command in sorted(
-                grouped_commands.items(),
-                key=lambda item: order.index(item[1]),
-            )
-        ] + sorted(ungrouped_command_names)
-
-
-app = ErrorHandledTyper(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    no_args_is_help=True,
-    cls=OrderCommands,
-)
-
-
-@app.callback()
-def version(
-    version: bool = typer.Option(
-        None,
-        "--version",
-        "-v",
-        callback=version_callback,
-        is_eager=True,
-        help="Print the version and exit",
-    )
-):
-    pass
-
-
-app.add_typer(project, rich_help_panel=CommandPanel.Commands)
-app.add_typer(missionCommands, rich_help_panel=CommandPanel.Commands)
-
-app.add_typer(topic, rich_help_panel=CommandPanel.Commands)
-app.add_typer(file, rich_help_panel=CommandPanel.Commands)
-app.add_typer(queue, rich_help_panel=CommandPanel.Commands)
-app.add_typer(user, rich_help_panel=CommandPanel.Commands)
-app.add_typer(tag, rich_help_panel=CommandPanel.Commands)
-app.add_typer(endpoint, rich_help_panel=CommandPanel.AdditionalCommands)
-
-app.command(rich_help_panel=CommandPanel.AdditionalCommands)(login)
-app.command(rich_help_panel=CommandPanel.AdditionalCommands)(logout)
-app.command(hidden=True)(setCliKey)
-
-
-@app.command("download", rich_help_panel=CommandPanel.CoreCommands)
-def download():
-    raise NotImplementedError("Not implemented yet.")
-
-
-@app.command("upload", rich_help_panel=CommandPanel.CoreCommands)
-def upload(
-    path: Annotated[
-        List[str],
-        typer.Option(prompt=True, help="Path to files to upload, Regex supported"),
-    ],
-    project: Annotated[str, typer.Option(prompt=True, help="Name of Project")],
-    mission: Annotated[
-        str, typer.Option(prompt=True, help="Name of Mission to create")
-    ],
-    tags: Annotated[
-        Optional[List[str]],
-        typer.Option(prompt=False, help="Tags to add to the mission"),
-    ] = None,
-):
-    """
-    Upload files matching the path to a mission in a project.
-
-    The mission name must be unique within the project and not yet created.\n
-    Multiple paths can be given by using the option multiple times.\n
-    Examples:\n
-        - 'klein upload --path "~/data/**/*.bag" --project "Project 1" --mission "Mission 1" --tags "0700946d-1d6a-4520-b263-0e177f49c35b:LEE-H" --tags "1565118d-593c-4517-8c2d-9658452d9319:Dodo"'\n
-
-    """
-    files = []
-    for p in path:
-        files.extend(expand_and_match(p))
-    filenames = list(
-        map(lambda x: x.split("/")[-1], filter(lambda x: not os.path.isdir(x), files))
-    )
-    if not filenames:
-        raise ValueError("No files found matching the given path.")
-
-    print(
-        f"Uploading the following files to mission '{mission}' in project '{project}':"
-    )
-    filepaths = {}
-    for path in files:
-        if not os.path.isdir(path):
-            filepaths[path.split("/")[-1]] = path
-            typer.secho(f" - {path}", fg=typer.colors.RESET)
-
-    try:
-        client = AuthenticatedClient()
-
-        get_project_url = "/project/byName"
-        project_response = client.get(get_project_url, params={"name": project})
-        if project_response.status_code >= 400:
-            raise AccessDeniedException(
-                f"The project '{project}' does not exist or you do not have access to it.\n"
-                f"Consider using the following command to create a project: 'klein project create'\n",
-                f"{project_response.json()['message']} ({project_response.status_code})",
-            )
-
-        project_json = project_response.json()
-        if not project_json["uuid"]:
-            print(f"Project not found: '{project}'")
-            return
-
-        can_upload = canUploadMission(client, project_json["uuid"])
-        if not can_upload:
-            raise AccessDeniedException(
-                f"You do not have the required permissions to upload to project '{project}'\n",
-                "Access Denied",
-            )
-
-        if not tags:
-            tags = []
-        tags_dict = {item.split(":")[0]: item.split(":")[1] for item in tags}
-
-        promptForTags(tags_dict, project_json["requiredTags"])
-
-        get_mission_url = "/mission/byName"
-        mission_response = client.get(get_mission_url, params={"name": mission})
-        mission_response.raise_for_status()
-        if mission_response.content:
-            mission_json = mission_response.json()
-            if mission_json["uuid"]:
-                raise ValueError(
-                    f"Mission {mission_json['name']} ({mission_json['uuid']}) already exists. Delete it or select "
-                    f"another name."
-                )
-            raise Exception(f"Something failed, should not happen")
-
-        create_mission_url = "/mission/create"
-        new_mission = client.post(
-            create_mission_url,
-            json={
-                "name": mission,
-                "projectUUID": project_json["uuid"],
-                "tags": tags_dict,
-            },
-        )
-        if new_mission.status_code >= 400:
-            raise ValueError(
-                "Failed to create mission. Status Code: "
-                + str(new_mission.status_code)
-                + "\n"
-                + new_mission.json()["message"]
-            )
-        new_mission_data = new_mission.json()
-
-        get_temporary_credentials = "/file/temporaryAccess"
-        response_2 = client.post(
-            get_temporary_credentials,
-            json={"filenames": filenames, "missionUUID": new_mission_data["uuid"]},
-        )
-        if response_2.status_code >= 400:
-            raise ValueError(
-                "Failed to get temporary credentials. Status Code: "
-                + str(response_2.status_code)
-                + "\n"
-                + response_2.json()["message"]
-            )
-        temp_credentials = response_2.json()
-        credential = temp_credentials["credentials"]
-        confirmed_files = temp_credentials["files"]
-        for _file in filenames:
-            if not _file in confirmed_files.keys():
-                raise Exception(
-                    "Could not upload File '" + _file + "'. Is the filename unique? "
-                )
-            confirmed_files[_file]["filepath"] = filepaths[_file]
-        if len(confirmed_files.keys()) > 0:
-            uploadFiles(confirmed_files, credential, 4)
-
-    except httpx.HTTPError as e:
-        print(e)
-
-
-@queue.command("list")
-def list_queue():
-    """List current Queue entities"""
-    try:
-        url = "/queue/active"
-        startDate = datetime.now().date() - timedelta(days=1)
-        client = AuthenticatedClient()
-        response = client.get(url, params={"startDate": startDate})
-        response.raise_for_status()
-        data = response.json()
-        table = Table("UUID", "filename", "mission", "state", "origin", "createdAt")
-        for topic in data:
-            table.add_row(
-                topic["uuid"],
-                topic["filename"],
-                topic["mission"]["name"],
-                topic["state"],
-                topic["location"],
-                topic["createdAt"],
-            )
-        print(table)
-
-    except httpx.HTTPError as e:
-        print(e)
-
-
-@app.command("claim", hidden=True)
-def claim():
-    """
-    Claim admin rights as the first user
-
-    Only works if no other user has claimed admin rights before.
-    """
-
-    client = AuthenticatedClient()
-    response = client.post("/user/claimAdmin")
-    response.raise_for_status()
-    print("Admin claimed.")
-
-
-if __name__ == "__main__":
-    app()

kleinkram-0.32.3/src/kleinkram/project/project.py

@@ -1,58 +0,0 @@
-from typing_extensions import Annotated
-
-import httpx
-import typer
-
-from kleinkram.api_client import AuthenticatedClient
-
-project = typer.Typer(
-    name="project",
-    help="Project operations",
-    no_args_is_help=True,
-    context_settings={"help_option_names": ["-h", "--help"]},
-)
-
-
-@project.command("list")
-def list_projects():
-    """
-    List all projects.
-    """
-    try:
-        client = AuthenticatedClient()
-        response = client.get("/project/filtered")
-        response.raise_for_status()
-        projects = response.json()[0]
-        print("Projects:")
-        for _project in projects:
-            print(f"- {_project['name']}")
-
-    except httpx.HTTPError as e:
-        print(f"Failed to fetch projects: {e}")
-
-
-@project.command("create")
-def create_project(
-    name: Annotated[str, typer.Option(help="Name of Project")],
-    description: Annotated[str, typer.Option(help="Description of Project")],
-):
-    """
-    Create a new project
-    """
-    # Todo add required tags as option.
-    try:
-        url = "/project/create"
-        client = AuthenticatedClient()
-        response = client.post(
-            url, json={"name": name, "description": description, "requiredTags": []}
-        )  # TODO: Add required tags as option
-        if response.status_code >= 400:
-            response_json = response.json()
-            response_text = response_json["message"]
-            print(f"Failed to create project: {response_text}")
-            return
-        print("Project created")
-
-    except httpx.HTTPError as e:
-        print(f"Failed to create project: {e}")
-        raise e