kleinkram 0.4.0.dev20240808080202__tar.gz → 0.5.0__tar.gz

{kleinkram-0.4.0.dev20240808080202 → kleinkram-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kleinkram
-Version: 0.4.0.dev20240808080202
+Version: 0.5.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.4.0.dev20240808080202 → kleinkram-0.5.0}/pyproject.toml

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

kleinkram-0.5.0/src/klein.py

@@ -0,0 +1,9 @@
+from kleinkram.main import app
+
+
+def main():
+    app()
+
+
+if __name__ == "__main__":
+    main()

kleinkram-0.5.0/src/kleinkram/api_client.py

@@ -0,0 +1,72 @@
+import httpx
+from rich.console import Console
+from rich.panel import Panel
+
+from kleinkram.auth.auth import TokenFile, CLI_KEY, AUTH_TOKEN, REFRESH_TOKEN
+
+
+class AuthenticatedClient(httpx.Client):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        try:
+            self.tokenfile = TokenFile()
+            self._load_cookies()
+        except Exception as e:
+
+            console = Console()
+            msg = f"You are not authenticated on endpoint '{self.tokenfile.endpoint}'. Please run 'klein login' to authenticate."
+
+            panel = Panel(
+                msg,
+                title="Not Authenticated",
+                style="yellow",
+                padding=(1, 2),
+                highlight=True,
+            )
+            print()
+            console.print(panel)
+            print()
+
+    def _load_cookies(self):
+        if self.tokenfile.isCliToken():
+            self.cookies.set(CLI_KEY, self.tokenfile.getCLIToken())
+        else:
+            self.cookies.set(AUTH_TOKEN, self.tokenfile.getAuthToken())
+
+    def refresh_token(self):
+        if self.tokenfile.isCliToken():
+            print("CLI key cannot be refreshed.")
+            return
+        refresh_token = self.tokenfile.getRefreshToken()
+        if not refresh_token:
+            print("No refresh token found. Please login again.")
+            raise Exception("No refresh token found.")
+        self.cookies.set(
+            REFRESH_TOKEN,
+            refresh_token,
+        )
+        response = self.post(
+            "/auth/refresh-token",
+        )
+        response.raise_for_status()
+        new_access_token = response.cookies.get(AUTH_TOKEN)
+        new_tokens = {AUTH_TOKEN: new_access_token, REFRESH_TOKEN: refresh_token}
+        self.tokenfile.saveTokens(new_tokens)
+        self.cookies.set(AUTH_TOKEN, new_access_token)
+
+    def request(self, method, url, *args, **kwargs):
+        response = super().request(
+            method, self.tokenfile.endpoint + url, *args, **kwargs
+        )
+        if (url == "/auth/refresh-token") and response.status_code == 401:
+            print("Refresh token expired. Please login again.")
+            response.status_code = 403
+            exit(1)
+        if response.status_code == 401:
+            print("Token expired, refreshing token...")
+            self.refresh_token()
+            response = super().request(
+                method, self.tokenfile.endpoint + url, *args, **kwargs
+            )
+        return response

{kleinkram-0.4.0.dev20240808080202/src/kleinkram → kleinkram-0.5.0/src/kleinkram/auth}/auth.py

@@ -3,17 +3,15 @@ import os
 import urllib.parse
 import webbrowser
 from http.server import BaseHTTPRequestHandler, HTTPServer
+from pathlib import Path
 from typing import Optional
 
+import typer
 from typing_extensions import Annotated
 
-from pathlib import Path
-
-import httpx
-import typer
+from kleinkram.consts import API_URL
 
 app = typer.Typer()
-from .consts import API_URL
 
 TOKEN_FILE = Path(os.path.expanduser("~/.kleinkram.json"))
 REFRESH_TOKEN = "refreshtoken"
@@ -87,62 +85,14 @@ def get_auth_tokens():
     return httpd.tokens
 
 
-class AuthenticatedClient(httpx.Client):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.tokenfile = TokenFile()
-            self._load_cookies()
-        except Exception as e:
-            print(
-                f"{self.tokenfile.endpoint} is not authenticated. Please run 'klein login'."
-            )
-
-    def _load_cookies(self):
-        if self.tokenfile.isCliToken():
-            self.cookies.set(CLI_KEY, self.tokenfile.getCLIToken())
-        else:
-            self.cookies.set(AUTH_TOKEN, self.tokenfile.getAuthToken())
-
-    def refresh_token(self):
-        if self.tokenfile.isCliToken():
-            print("CLI key cannot be refreshed.")
-            return
-        refresh_token = self.tokenfile.getRefreshToken()
-        if not refresh_token:
-            print("No refresh token found. Please login again.")
-            raise Exception("No refresh token found.")
-        self.cookies.set(
-            REFRESH_TOKEN,
-            refresh_token,
-        )
-        response = self.post(
-            "/auth/refresh-token",
-        )
-        response.raise_for_status()
-        new_access_token = response.cookies.get(AUTH_TOKEN)
-        new_tokens = {AUTH_TOKEN: new_access_token, REFRESH_TOKEN: refresh_token}
-        self.tokenfile.saveTokens(new_tokens)
-        self.cookies.set(AUTH_TOKEN, new_access_token)
-
-    def request(self, method, url, *args, **kwargs):
-        response = super().request(
-            method, self.tokenfile.endpoint + url, *args, **kwargs
-        )
-        if (url == "/auth/refresh-token") and response.status_code == 401:
-            print("Refresh token expired. Please login again.")
-            response.status_code = 403
-            exit(1)
-        if response.status_code == 401:
-            print("Token expired, refreshing token...")
-            self.refresh_token()
-            response = super().request(
-                method, self.tokenfile.endpoint + url, *args, **kwargs
-            )
-        return response
-
-
-client = AuthenticatedClient()
+def logout():
+    """
+    Logout from the currently set endpoint.
+    """
+    tokenfile = TokenFile()
+    tokenfile.tokens[tokenfile.endpoint] = {}
+    tokenfile.writeToFile()
+    print("Logged out.")
 
 
 def login(
@@ -157,7 +107,10 @@ def login(
     """
     tokenfile = TokenFile()
     if key:
-        tokenfile.saveTokens(key)
+        token = {}
+        token[CLI_KEY] = key
+        tokenfile.saveTokens(token)
+
     else:
         url = tokenfile.endpoint + "/auth/google?state=cli"
 

kleinkram-0.5.0/src/kleinkram/file/file.py

@@ -0,0 +1,109 @@
+from typing import Optional, Annotated
+
+import httpx
+import typer
+
+from kleinkram.api_client import AuthenticatedClient
+
+file = typer.Typer(
+    name="file",
+    help="File operations",
+    no_args_is_help=True,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+@file.command("list")
+def list_files(
+    project: Optional[str] = typer.Option(None, help="Name of Project"),
+    mission: Optional[str] = typer.Option(None, help="Name of Mission"),
+    topics: Optional[str] = typer.Option(None, help="Comma separated list of topics"),
+    tags: Optional[str] = typer.Option(
+        None, help="Comma separated list of tagtype:tagvalue pairs"
+    ),
+):
+    """
+    List all files with optional filters for project, mission, or topics.
+
+    Can list files of a project, mission, or with specific topics (Logical AND).
+    Examples:\n
+        - 'klein filelist'\n
+        - 'klein file list --project "Project 1"'\n
+        - 'klein file list --mission "Mission 1"'\n
+        - 'klein file list --topics "/elevation_mapping/semantic_map,/elevation_mapping/elevation_map_raw"'\n
+        - 'klein file list --topics "/elevation_mapping/semantic_map,/elevation_mapping/elevation_map_raw" --mission "Mission A"'
+    """
+    try:
+        url = f"/file/filteredByNames"
+        params = {}
+        if project:
+            params["projectName"] = project
+        if mission:
+            params["missionName"] = mission
+        if topics:
+            params["topics"] = topics
+        if tags:
+            params["tags"] = {}
+            for tag in tags.split(","):
+                tagtype, tagvalue = tag.split("§")
+                params["tags"][tagtype] = tagvalue
+
+        client = AuthenticatedClient()
+        response = client.get(
+            url,
+            params=params,
+        )
+        response.raise_for_status()
+        data = response.json()
+        missions_by_project_uuid = {}
+        files_by_mission_uuid = {}
+        for file in data:
+            mission_uuid = file["mission"]["uuid"]
+            project_uuid = file["mission"]["project"]["uuid"]
+            if project_uuid not in missions_by_project_uuid:
+                missions_by_project_uuid[project_uuid] = []
+            if mission_uuid not in missions_by_project_uuid[project_uuid]:
+                missions_by_project_uuid[project_uuid].append(mission_uuid)
+            if mission_uuid not in files_by_mission_uuid:
+                files_by_mission_uuid[mission_uuid] = []
+            files_by_mission_uuid[mission_uuid].append(file)
+
+        print("Files by mission & Project:")
+        for project_uuid, missions in missions_by_project_uuid.items():
+            first_file = files_by_mission_uuid[missions[0]][0]
+            print(f"* {first_file['mission']['project']['name']}")
+            for mission in missions:
+                print(f"  - {files_by_mission_uuid[mission][0]['mission']['name']}")
+                for file in files_by_mission_uuid[mission]:
+                    print(f"    - '{file['filename']}'")
+
+    except httpx.HTTPError as e:
+        print(f"Failed to fetch missions: {e}")
+
+
+@file.command("download")
+def download(
+    missionuuid: Annotated[str, typer.Argument()],
+):
+    """Download file"""
+    try:
+        client = AuthenticatedClient()
+        response = client.get("/file/downloadWithToken", params={"uuid": missionuuid})
+        response.raise_for_status()
+        print(response.json())
+    except:
+        print("Failed to download file")
+
+
+@file.command("clear")
+def clear_queue():
+    """Clear queue"""
+    # Prompt the user for confirmation
+    confirmation = typer.prompt("Are you sure you want to clear the Files? (y/n)")
+    if confirmation.lower() == "y":
+        client = AuthenticatedClient()
+        response = client.delete("/file/clear")
+        response.raise_for_status()
+        print("Files cleared.")
+    else:
+        print("Operation cancelled.")

{kleinkram-0.4.0.dev20240808080202 → kleinkram-0.5.0}/src/kleinkram/helper.py

@@ -1,15 +1,14 @@
+import glob
 import os
+import queue
 import threading
-import glob
+from typing import Dict
 
 import httpx
 import tqdm
 from rich import print
-import queue
-
-from typing import Dict
 
-from .auth import client
+from kleinkram.api_client import AuthenticatedClient
 
 
 def expand_and_match(path_pattern):
@@ -54,6 +53,7 @@ def uploadFile(_queue: queue.Queue, paths: Dict[str, str], pbar: tqdm):
                     response = cli.put(url, content=f, headers=headers)
                     if response.status_code == 200:
                         pbar.update(100)  # Update progress for each file
+                        client = AuthenticatedClient()
                         client.post("/queue/confirmUpload", json={"uuid": uuid})
                     else:
                         print(

kleinkram-0.5.0/src/kleinkram/main.py

@@ -0,0 +1,265 @@
+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
+
+from kleinkram.api_client import AuthenticatedClient
+from kleinkram.auth.auth import login, endpoint, setEndpoint, setCliKey, logout
+from kleinkram.file.file import file
+from kleinkram.mission.mission import mission
+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
+
+
+class Panel(str, Enum):
+    CoreCommands = "CORE COMMANDS"
+    Commands = "COMMANDS"
+    AdditionalCommands = "ADDITIONAL COMMANDS"
+
+
+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(Panel)
+        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 = typer.Typer(
+    context_settings={"help_option_names": ["-h", "--help"]},
+    no_args_is_help=True,
+    cls=OrderCommands,
+)
+
+app.add_typer(project, rich_help_panel=Panel.Commands)
+app.add_typer(mission, rich_help_panel=Panel.Commands)
+
+app.add_typer(topic, rich_help_panel=Panel.Commands)
+app.add_typer(file, rich_help_panel=Panel.Commands)
+app.add_typer(queue, rich_help_panel=Panel.Commands)
+app.add_typer(user, rich_help_panel=Panel.Commands)
+app.add_typer(tag, rich_help_panel=Panel.Commands)
+
+app.command(rich_help_panel=Panel.CoreCommands)(login)
+app.command(rich_help_panel=Panel.CoreCommands)(logout)
+app.command(rich_help_panel=Panel.AdditionalCommands)(endpoint)
+app.command(rich_help_panel=Panel.AdditionalCommands)(setEndpoint)
+app.command(hidden=True)(setCliKey)
+
+
+@app.command("download", rich_help_panel=Panel.CoreCommands)
+def download():
+    raise NotImplementedError("Not implemented yet.")
+
+
+@app.command("upload", rich_help_panel=Panel.CoreCommands)
+def upload(
+    path: Annotated[
+        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")
+    ],
+):
+    """
+    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
+    Examples:\n
+        - 'klein upload --path "~/data/**/*.bag" --project "Project 1" --mission "Mission 1"'\n
+
+    """
+    files = expand_and_match(path)
+    filenames = list(
+        map(lambda x: x.split("/")[-1], filter(lambda x: not os.path.isdir(x), files))
+    )
+    if not filenames:
+        print("No files found")
+        return
+    filepaths = {}
+    for path in files:
+        if not os.path.isdir(path):
+            filepaths[path.split("/")[-1]] = path
+            print(f"  - {path}")
+    try:
+        client = AuthenticatedClient()
+
+        get_project_url = "/project/byName"
+        project_response = client.get(get_project_url, params={"name": project})
+        if project_response.status_code >= 400:
+            print(f"Failed to fetch project: {project_response.text}")
+            return
+        project_json = project_response.json()
+        if not project_json["uuid"]:
+            print(f"Project not found: {project}")
+            return
+
+        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"]:
+                print(
+                    f"mission: {mission_json['uuid']} already exists. Delete it or select another name."
+                )
+                return
+            print(f"Something failed, should not happen")
+            return
+
+        create_mission_url = "/mission/create"
+        new_mission = client.post(
+            create_mission_url,
+            json={"name": mission, "projectUUID": project_json["uuid"], "tags": []},
+        )
+        new_mission.raise_for_status()
+        new_mission_data = new_mission.json()
+        print(f"Created mission: {new_mission_data['name']}")
+
+        get_presigned_url = "/queue/createPreSignedURLS"
+
+        response_2 = client.post(
+            get_presigned_url,
+            json={"filenames": filenames, "missionUUID": new_mission_data["uuid"]},
+        )
+        response_2.raise_for_status()
+        presigned_urls = response_2.json()
+        for file in filenames:
+            if not file in presigned_urls.keys():
+                print("Could not upload File '" + file + "'. Is the filename unique? ")
+        if len(presigned_urls) > 0:
+            uploadFiles(presigned_urls, filepaths, 4)
+
+    except httpx.HTTPError as e:
+        print(e)
+
+
+@queue.command("clear")
+def clear_queue():
+    """Clear queue"""
+    # Prompt the user for confirmation
+    confirmation = typer.prompt("Are you sure you want to clear the queue? (y/n)")
+    if confirmation.lower() == "y":
+        client = AuthenticatedClient()
+        response = client.delete("/queue/clear")
+        response.raise_for_status()
+        print("Queue cleared.")
+    else:
+        print("Operation cancelled.")
+
+
+@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("wipe", hidden=True)
+def wipe():
+    """Wipe all data"""
+    # Prompt the user for confirmation
+    confirmation = typer.prompt("Are you sure you want to wipe all data? (y/n)")
+    if confirmation.lower() == "y":
+        second_confirmation = typer.prompt(
+            "This action is irreversible. Are you really sure? (y/n)"
+        )
+        if second_confirmation.lower() != "y":
+            print("Operation cancelled.")
+            return
+
+        client = AuthenticatedClient()
+        response_queue = client.delete("/queue/clear")
+        response_file = client.delete("/file/clear")
+        response_analysis = client.delete("/analysis/clear")
+        response_mission = client.delete("/mission/clear")
+        response_project = client.delete("/project/clear")
+
+        if response_queue.status_code >= 400:
+            print("Failed to clear queue.")
+            print(response_queue.text)
+        elif response_file.status_code >= 400:
+            print("Failed to clear files.")
+            print(response_file.text)
+        elif response_analysis.status_code >= 400:
+            print("Failed to clear analysis.")
+            print(response_analysis.text)
+        elif response_mission.status_code >= 400:
+            print("Failed to clear missions.")
+            print(response_mission.text)
+        elif response_project.status_code >= 400:
+            print("Failed to clear projects.")
+            print(response_project.text)
+        else:
+            print("Data wiped.")
+    else:
+        print("Operation cancelled.")
+
+
+@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()