kleinkram 0.33.0.dev20241027195827__tar.gz → 0.33.0.dev20241028075757__tar.gz

{kleinkram-0.33.0.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kleinkram
-Version: 0.33.0.dev20241027195827
+Version: 0.33.0.dev20241028075757
 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.33.0.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/pyproject.toml

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

{kleinkram-0.33.0.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/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.33.0.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/src/kleinkram/error_handling.py

@@ -28,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),

{kleinkram-0.33.0.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/src/kleinkram/helper.py

@@ -1,6 +1,7 @@
 import glob
 import os
 import queue
+import re
 import sys
 import threading
 from datetime import datetime
@@ -149,7 +150,7 @@ def uploadFile(
             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")
+                console = Console(file=sys.stderr, style="red", highlight=False)
                 console.print(
                     f"Error uploading file: {file_with_access['fileName']} ({filepath}): {file_with_access['error']}"
                 )
@@ -252,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.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/src/kleinkram/main.py

@@ -25,7 +25,13 @@ 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
+from .helper import (
+    uploadFiles,
+    expand_and_match,
+    canUploadMission,
+    promptForTags,
+    is_valid_UUIDv4,
+)
 
 
 class CommandPanel(str, Enum):
@@ -113,7 +119,9 @@ app.command(hidden=True)(setCliKey)
 
 @app.command("download", rich_help_panel=CommandPanel.CoreCommands)
 def download():
-    raise NotImplementedError("Not implemented yet.")
+    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)
@@ -122,8 +130,8 @@ def upload(
         List[str],
         typer.Option(help="Path to files to upload, Regex supported"),
     ],
-    project: Annotated[str, typer.Option(help="Name of Project")],
-    mission: Annotated[str, typer.Option(help="Name of Mission to create")],
+    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"),
@@ -150,76 +158,33 @@ def upload(
         - '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))
-
-    print(
-        f"Uploading the following files to mission '{mission}' in project '{project}':"
-    )
-    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."
-        )
 
     client = AuthenticatedClient()
 
-    get_project_url = "/project/byName"
-    project_response = client.get(get_project_url, params={"name": project})
+    ##############################
+    # 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:
+        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"
@@ -260,8 +225,16 @@ def upload(
     )
     promptForTags(tags_dict, required_tags)
 
-    get_mission_url = "/mission/byName"
-    mission_response = client.get(get_mission_url, params={"name": mission})
+    ##############################
+    # 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(
@@ -290,6 +263,64 @@ def upload(
 
     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,

{kleinkram-0.33.0.dev20241027195827 → kleinkram-0.33.0.dev20241028075757}/src/kleinkram/project/project.py

@@ -24,6 +24,10 @@ def list_projects():
     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:")
@@ -46,7 +50,7 @@ def list_projects():
     stderr_console.print("\n")
 
 
-@project.command("details", help="Get details of a project")
+@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")
@@ -97,7 +101,7 @@ def project_details(
         stdout_console.print(mission["uuid"])
 
 
-@project.command("create")
+@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")],
@@ -115,10 +119,20 @@ def create_project(
         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")
+            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()