kleinkram 0.4.0__py3-none-any.whl → 0.4.0.dev20240808144850__py3-none-any.whl

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/{auth.py → 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/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/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/main.py

@@ -1,273 +1,89 @@
-import sys
-from datetime import datetime, timedelta
 import os
+from datetime import datetime, timedelta
+from enum import Enum
 
 import httpx
 import typer
-from typing import List, Optional
-from typing_extensions import Annotated
 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
 
-from .auth import login, client, endpoint, setCliKey, setEndpoint
-
-app = typer.Typer()
-projects = typer.Typer(name="projects", help="Project operations")
-missions = typer.Typer(name="missions", help="Mission operations")
-files = typer.Typer(name="files", help="File operations")
-topics = typer.Typer(name="topics", help="Topic operations")
-queue = typer.Typer(name="queue", help="Status of files uploading")
-user = typer.Typer(name="users", help="User operations")
-tagtypes = typer.Typer(name="tagtypes", help="TagType operations")
-tag = typer.Typer(name="tag", help="Tag operations")
-
-
-app.add_typer(projects)
-app.add_typer(missions)
-app.add_typer(topics)
-app.add_typer(files)
-app.add_typer(queue)
-app.add_typer(user)
-app.add_typer(tagtypes)
-app.add_typer(tag)
-app.command()(login)
-app.command()(endpoint)
-app.command()(setEndpoint)
-app.command(hidden=True)(setCliKey)
-
-
-@files.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 files list'\n
-        - 'klein files list --project "Project 1"'\n
-        - 'klein files list --mission "Mission 1"'\n
-        - 'klein files list --topics "/elevation_mapping/semantic_map,/elevation_mapping/elevation_map_raw"'\n
-        - 'klein files 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
-        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}")
+class Panel(str, Enum):
+    CoreCommands = "CORE COMMANDS"
+    Commands = "COMMANDS"
+    AdditionalCommands = "ADDITIONAL COMMANDS"
 
 
-@projects.command("list")
-def list_projects():
-    """
-    List all projects.
+class OrderCommands(TyperGroup):
     """
-    try:
-        response = client.get("/project")
-        response.raise_for_status()
-        projects = response.json()
-        print("Projects:")
-        for project in projects:
-            print(f"- {project['name']}")
-
-    except httpx.HTTPError as e:
-        print(f"Failed to fetch projects: {e}")
-
 
-@missions.command("list")
-def list_missions(
-    project: Optional[str] = typer.Option(None, help="Name of Project"),
-    verbose: Optional[bool] = typer.Option(
-        False, help="Outputs a table with more information"
-    ),
-):
-    """
-    List all missions with optional filter for project.
+    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.
     """
-    try:
-        url = "/mission"
-        if project:
-            url += f"/filteredByProjectName/{project}"
-        else:
-            url += "/all"
-        response = client.get(url)
-        response.raise_for_status()
-        data = response.json()
-        missions_by_project_uuid = {}
-        for mission in data:
-            project_uuid = mission["project"]["uuid"]
-            if project_uuid not in missions_by_project_uuid:
-                missions_by_project_uuid[project_uuid] = []
-            missions_by_project_uuid[project_uuid].append(mission)
-
-        print("missions by Project:")
-        if not verbose:
-            for project_uuid, missions in missions_by_project_uuid.items():
-                print(
-                    f"* {missions_by_project_uuid[project_uuid][0]['project']['name']}"
-                )
-                for mission in missions:
-                    print(f"  - {mission['name']}")
-        else:
-            table = Table("UUID", "name", "project", "creator", "createdAt")
-            for project_uuid, missions in missions_by_project_uuid.items():
-                for mission in missions:
-                    table.add_row(
-                        mission["uuid"],
-                        mission["name"],
-                        mission["project"]["name"],
-                        mission["creator"]["name"],
-                        mission["createdAt"],
-                    )
-            print(table)
-
-    except httpx.HTTPError as e:
-        print(f"Failed to fetch missions: {e}")
 
+    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)
 
-@missions.command("byUUID")
-def mission_by_uuid(
-    uuid: Annotated[str, typer.Argument()],
-    json: Optional[bool] = typer.Option(False, help="Output as JSON"),
-):
-    """
-    Get mission name, project name, creator and table of its files given a Mission UUID
 
-    Use the JSON flag to output the full JSON response instead.
+app = typer.Typer(
+    context_settings={"help_option_names": ["-h", "--help"]},
+    no_args_is_help=True,
+    cls=OrderCommands,
+)
 
-    Can be run with API Key or with login.
-    """
-    try:
-        url = "/mission/byUUID"
-        response = client.get(url, params={"uuid": uuid})
-        response.raise_for_status()
-        data = response.json()
-        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"])
-            print(table)
-    except httpx.HTTPError as e:
-        print(f"Failed to fetch missions: {e}")
+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)
 
-@topics.command("list")
-def topics(
-    file: Annotated[str, typer.Option(help="Name of File")],
-    full: Annotated[
-        bool, typer.Option(help="As a table with additional parameters")
-    ] = False,
-    # Todo add mission / project as optional argument as filenames are not unique or handle multiple files
-):
-    """
-    List topics for a file
+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)
 
-    Only makes sense with MCAP files as we don't associate topics with BAGs as that would be redundant.
-    """
-    if file.endswith(".bag"):
-        print("BAG files generally do not have topics")
-    try:
-        url = "/file/byName"
-        response = client.get(url, params={"name": file})
-        response.raise_for_status()
-        data = response.json()
-        if not full:
-            for topic in data["topics"]:
-                print(f" - {topic['name']}")
-        else:
-            table = Table("UUID", "name", "type", "nrMessages", "frequency")
-            for topic in data["topics"]:
-                table.add_row(
-                    topic["uuid"],
-                    topic["name"],
-                    topic["type"],
-                    topic["nrMessages"],
-                    f"{topic['frequency']}",
-                )
-            print(table)
 
-    except httpx.HTTPError as e:
-        print(f"Failed")
+@app.command("download", rich_help_panel=Panel.CoreCommands)
+def download():
+    raise NotImplementedError("Not implemented yet.")
 
 
-@projects.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"
-        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}")
-
-
-@app.command("upload")
+@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")
@@ -298,6 +114,8 @@ def upload(
             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:
@@ -354,6 +172,7 @@ def 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.")
@@ -367,6 +186,7 @@ def list_queue():
     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()
@@ -386,19 +206,6 @@ def list_queue():
         print(e)
 
 
-@files.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":
-        response = client.delete("/file/clear")
-        response.raise_for_status()
-        print("Files cleared.")
-    else:
-        print("Operation cancelled.")
-
-
 @app.command("wipe", hidden=True)
 def wipe():
     """Wipe all data"""
@@ -412,6 +219,7 @@ def wipe():
             print("Operation cancelled.")
             return
 
+        client = AuthenticatedClient()
         response_queue = client.delete("/queue/clear")
         response_file = client.delete("/file/clear")
         response_analysis = client.delete("/analysis/clear")
@@ -446,121 +254,12 @@ def claim():
 
     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.")
 
 
-@user.command("list")
-def users():
-    """List all users"""
-    response = client.get("/user/all")
-    response.raise_for_status()
-    data = response.json()
-    table = Table("Name", "Email", "Role", "googleId")
-    for user in data:
-        table.add_row(user["name"], user["email"], user["role"], user["googleId"])
-    print(table)
-
-
-@user.command("info")
-def user_info():
-    """Get logged in user info"""
-    response = client.get("/user/me")
-    response.raise_for_status()
-    data = response.json()
-    print(data)
-
-
-@user.command("promote")
-def promote(email: Annotated[str, typer.Option()]):
-    """Promote another user to admin"""
-    response = client.post("/user/promote", json={"email": email})
-    response.raise_for_status()
-    print("User promoted.")
-
-
-@user.command("demote")
-def demote(email: Annotated[str, typer.Option()]):
-    """Demote another user from admin"""
-    response = client.post("/user/demote", json={"email": email})
-    response.raise_for_status()
-    print("User demoted.")
-
-
-@files.command("download")
-def download(
-    missionuuid: Annotated[str, typer.Argument()],
-):
-    """Download file"""
-    try:
-        response = client.get("/file/downloadWithToken", params={"uuid": missionuuid})
-        response.raise_for_status()
-        print(response.json())
-    except:
-        print("Failed to download file")
-
-
-@missions.command("tag")
-def addTag(
-    missionuuid: Annotated[str, typer.Argument()],
-    tagtypeuuid: Annotated[str, typer.Argument()],
-    value: Annotated[str, typer.Argument()],
-):
-    """Tag a mission"""
-    try:
-        response = client.post(
-            "/tag/addTag",
-            json={"mission": missionuuid, "tagType": tagtypeuuid, "value": value},
-        )
-        if response.status_code < 400:
-            print("Tagged mission")
-        else:
-            print(response.json())
-            print("Failed to tag mission")
-    except httpx.HTTPError as e:
-        print(e)
-        print("Failed to tag mission")
-        sys.exit(1)
-
-
-@tagtypes.command("list")
-def tagTypes(
-    verbose: Annotated[bool, typer.Option()] = False,
-):
-    """List all tagtypes"""
-    try:
-        response = client.get("/tag/all")
-        response.raise_for_status()
-        data = response.json()
-        if verbose:
-            table = Table("UUID", "Name", "Datatype")
-            for tagtype in data:
-                table.add_row(tagtype["uuid"], tagtype["name"], tagtype["datatype"])
-        else:
-            table = Table("Name", "Datatype")
-            for tagtype in data:
-                table.add_row(tagtype["name"], tagtype["datatype"])
-        print(table)
-    except:
-        print("Failed to fetch tagtypes")
-
-
-@tag.command("delete")
-def deleteTag(
-    taguuid: Annotated[str, typer.Argument()],
-):
-    """Delete a tag"""
-    try:
-        response = client.delete("/tag/deleteTag", params={"uuid": taguuid})
-        if response.status_code < 400:
-            print("Deleted tag")
-        else:
-            print(response)
-            print("Failed to delete tag")
-    except:
-        print("Failed to delete tag")
-
-
 if __name__ == "__main__":
     app()

kleinkram/mission/mission.py

@@ -0,0 +1,126 @@
+import sys
+from typing import Annotated, Optional
+
+import httpx
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from kleinkram.api_client import AuthenticatedClient
+
+mission = typer.Typer(
+    name="mission",
+    help="Mission operations",
+    no_args_is_help=True,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+@mission.command("tag")
+def addTag(
+    missionuuid: Annotated[str, typer.Argument()],
+    tagtypeuuid: Annotated[str, typer.Argument()],
+    value: Annotated[str, typer.Argument()],
+):
+    """Tag a mission"""
+    try:
+        client = AuthenticatedClient()
+        response = client.post(
+            "/tag/addTag",
+            json={"mission": missionuuid, "tagType": tagtypeuuid, "value": value},
+        )
+        if response.status_code < 400:
+            print("Tagged mission")
+        else:
+            print(response.json())
+            print("Failed to tag mission")
+    except httpx.HTTPError as e:
+        print(e)
+        print("Failed to tag mission")
+        sys.exit(1)
+
+
+@mission.command("list")
+def list_missions(
+    project: Optional[str] = typer.Option(None, help="Name of Project"),
+    verbose: Optional[bool] = typer.Option(
+        False, help="Outputs a table with more information"
+    ),
+):
+    """
+    List all missions with optional filter for project.
+    """
+    try:
+        url = "/mission"
+        if project:
+            url += f"/filteredByProjectName/{project}"
+        else:
+            url += "/all"
+            client = AuthenticatedClient()
+
+        response = client.get(url)
+        response.raise_for_status()
+        data = response.json()
+        missions_by_project_uuid = {}
+        for mission in data:
+            project_uuid = mission["project"]["uuid"]
+            if project_uuid not in missions_by_project_uuid:
+                missions_by_project_uuid[project_uuid] = []
+            missions_by_project_uuid[project_uuid].append(mission)
+
+        print("missions by Project:")
+        if not verbose:
+            for project_uuid, missions in missions_by_project_uuid.items():
+                print(
+                    f"* {missions_by_project_uuid[project_uuid][0]['project']['name']}"
+                )
+                for mission in missions:
+                    print(f"  - {mission['name']}")
+        else:
+            table = Table("UUID", "name", "project", "creator", "createdAt")
+            for project_uuid, missions in missions_by_project_uuid.items():
+                for mission in missions:
+                    table.add_row(
+                        mission["uuid"],
+                        mission["name"],
+                        mission["project"]["name"],
+                        mission["creator"]["name"],
+                        mission["createdAt"],
+                    )
+            print(table)
+
+    except httpx.HTTPError as e:
+        print(f"Failed to fetch missions: {e}")
+
+
+@mission.command("byUUID")
+def mission_by_uuid(
+    uuid: Annotated[str, typer.Argument()],
+    json: Optional[bool] = typer.Option(False, help="Output as JSON"),
+):
+    """
+    Get mission name, project name, creator and table of its files given a Mission UUID
+
+    Use the JSON flag to output the full JSON response instead.
+
+    Can be run with API Key or with login.
+    """
+    try:
+        url = "/mission/byUUID"
+        client = AuthenticatedClient()
+        response = client.get(url, params={"uuid": uuid})
+        response.raise_for_status()
+        data = response.json()
+        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)
+    except httpx.HTTPError as e:
+        print(f"Failed to fetch missions: {e}")

kleinkram/project/project.py

@@ -0,0 +1,57 @@
+from typing 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")
+        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}")

kleinkram/queue/queue.py

@@ -0,0 +1,8 @@
+import typer
+
+queue = typer.Typer(
+    name="queue",
+    help="Status of files uploading",
+    no_args_is_help=True,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)

kleinkram/tag/tag.py

@@ -0,0 +1,48 @@
+from typing import Annotated
+
+import typer
+from rich.table import Table
+
+from kleinkram.api_client import AuthenticatedClient
+
+tag = typer.Typer(name="tag", help="Tag operations")
+
+
+@tag.command("list-tag-types")
+def tagTypes(
+    verbose: Annotated[bool, typer.Option()] = False,
+):
+    """List all tagtypes"""
+    try:
+        client = AuthenticatedClient()
+        response = client.get("/tag/all")
+        response.raise_for_status()
+        data = response.json()
+        if verbose:
+            table = Table("UUID", "Name", "Datatype")
+            for tagtype in data:
+                table.add_row(tagtype["uuid"], tagtype["name"], tagtype["datatype"])
+        else:
+            table = Table("Name", "Datatype")
+            for tagtype in data:
+                table.add_row(tagtype["name"], tagtype["datatype"])
+        print(table)
+    except:
+        print("Failed to fetch tagtypes")
+
+
+@tag.command("delete")
+def deleteTag(
+    taguuid: Annotated[str, typer.Argument()],
+):
+    """Delete a tag"""
+    try:
+        client = AuthenticatedClient()
+        response = client.delete("/tag/deleteTag", params={"uuid": taguuid})
+        if response.status_code < 400:
+            print("Deleted tag")
+        else:
+            print(response)
+            print("Failed to delete tag")
+    except:
+        print("Failed to delete tag")

kleinkram/topic/topic.py

@@ -0,0 +1,54 @@
+from typing import Annotated
+
+import httpx
+import typer
+from rich.table import Table
+
+from kleinkram.api_client import AuthenticatedClient
+
+topic = typer.Typer(
+    name="topic",
+    help="Topic operations",
+    no_args_is_help=True,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+@topic.command("list")
+def topics(
+    file: Annotated[str, typer.Option(help="Name of File")],
+    full: Annotated[
+        bool, typer.Option(help="As a table with additional parameters")
+    ] = False,
+    # Todo add mission / project as optional argument as filenames are not unique or handle multiple files
+):
+    """
+    List topics for a file
+
+    Only makes sense with MCAP files as we don't associate topics with BAGs as that would be redundant.
+    """
+    if file.endswith(".bag"):
+        print("BAG files generally do not have topics")
+    try:
+        url = "/file/byName"
+        client = AuthenticatedClient()
+        response = client.get(url, params={"name": file})
+        response.raise_for_status()
+        data = response.json()
+        if not full:
+            for topic in data["topics"]:
+                print(f" - {topic['name']}")
+        else:
+            table = Table("UUID", "name", "type", "nrMessages", "frequency")
+            for topic in data["topics"]:
+                table.add_row(
+                    topic["uuid"],
+                    topic["name"],
+                    topic["type"],
+                    topic["nrMessages"],
+                    f"{topic['frequency']}",
+                )
+            print(table)
+
+    except httpx.HTTPError as e:
+        print(f"Failed")

kleinkram/user/user.py

@@ -0,0 +1,53 @@
+from typing import Annotated
+
+import typer
+from rich.table import Table
+
+from kleinkram.api_client import AuthenticatedClient
+
+user = typer.Typer(
+    name="users",
+    help="User operations",
+)
+
+
+@user.command("list")
+def users(ctx: typer.Context):
+    """List all users"""
+
+    client = AuthenticatedClient()
+    response = client.get("/user/all")
+    response.raise_for_status()
+    data = response.json()
+    table = Table("Name", "Email", "Role", "googleId")
+    for user in data:
+        table.add_row(user["name"], user["email"], user["role"], user["googleId"])
+    print(table)
+
+
+@user.command("info")
+def user_info():
+    """Get logged in user info"""
+    client = AuthenticatedClient()
+    response = client.get("/user/me")
+    response.raise_for_status()
+    data = response.json()
+    print(data)
+
+
+@user.command("promote")
+def promote(email: Annotated[str, typer.Option()]):
+    """Promote another user to admin"""
+    client = AuthenticatedClient()
+    response = client.post("/user/promote", json={"email": email})
+    response.raise_for_status()
+    print("User promoted.")
+
+
+@user.command("demote")
+def demote(email: Annotated[str, typer.Option()]):
+    """Demote another user from admin"""
+    client = AuthenticatedClient()
+    response = client.post("/user/demote", json={"email": email})
+    response.raise_for_status()
+    print("User demoted.")

{kleinkram-0.4.0.dist-info → kleinkram-0.4.0.dev20240808144850.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kleinkram
-Version: 0.4.0
+Version: 0.4.0.dev20240808144850
 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.dev20240808144850.dist-info/RECORD

@@ -0,0 +1,18 @@
+kleinkram/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kleinkram/api_client.py,sha256=RVfHl5yAIYa-sYnyOoG6MATfmyhND5cp4yCbiGYpWDI,2494
+kleinkram/consts.py,sha256=pm_6OuQcO-tYcRhwauTtyRRsuYY0y0yb6EGuIl49LnI,50
+kleinkram/helper.py,sha256=9YUuCH0pfj7gK88XRtR0SD-cfdcbR-4g0DdAcUfwdm4,2334
+kleinkram/main.py,sha256=HBPiTMyQ8ykBlkKmMDooVX2J30aaoQ-NPTF_qNE5Tmg,8883
+kleinkram/auth/auth.py,sha256=vk2Qv7v7tb1GziVzVq5ZaiEk39wVDVRBENhUd4pxk1g,5928
+kleinkram/file/file.py,sha256=ti-h72JdUs1UdYK7pElbQ-CpWiBQIEA-BhJ-8lgnDGc,3896
+kleinkram/mission/mission.py,sha256=arKZbSE9bd7fwcT9fpoy3W1na6Vvn-bkyTV2gCLFLng,4041
+kleinkram/project/project.py,sha256=p9fe4XQtGLTMDxHK7ofbe_8Sdv-aZ8I4KgseAn8RK20,1566
+kleinkram/queue/queue.py,sha256=MaLBjAu8asi9BkPvbbT-5AobCcpy3ex5rxM1kHpRINA,181
+kleinkram/tag/tag.py,sha256=0CN4XwcHmFNFc4n05o82bm2LRfm38NcN3U19vQ6Dqfc,1341
+kleinkram/topic/topic.py,sha256=5_Vh38GkJ1eu1_hfIUtmjoxgaprDlbaglmuQmjFmpJc,1614
+kleinkram/user/user.py,sha256=i_QfsctjhImvKKjuDPfOIyDr322SXgV-KxJo-a7qNZw,1368
+kleinkram-0.4.0.dev20240808144850.dist-info/METADATA,sha256=TwAbpkNu5rjtGCu8GiBmO03a_ro7eQAm3VhfvnlBfjA,749
+kleinkram-0.4.0.dev20240808144850.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+kleinkram-0.4.0.dev20240808144850.dist-info/entry_points.txt,sha256=RHXtRzcreVHImatgjhQwZQ6GdJThElYjHEWcR1BPXUI,45
+kleinkram-0.4.0.dev20240808144850.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+kleinkram-0.4.0.dev20240808144850.dist-info/RECORD,,

kleinkram-0.4.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-kleinkram/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kleinkram/auth.py,sha256=-XxVw3qLbWHT5Pv-yFyyxagu01RP8FlFLY-P274inYc,7739
-kleinkram/consts.py,sha256=pm_6OuQcO-tYcRhwauTtyRRsuYY0y0yb6EGuIl49LnI,50
-kleinkram/helper.py,sha256=5JbDBgaWjfenCHsRbNSdVZo7XfDaJ8VK_it7edi0ERU,2252
-kleinkram/main.py,sha256=vhr75e0AXxdUz1nd9q-EwZbMk45uYmm8TxmHKLPAZBU,18655
-kleinkram-0.4.0.dist-info/METADATA,sha256=Krv_M0yYS5AyrTtCd5U2e2qtLVV6ukPIHkOtKToow6o,731
-kleinkram-0.4.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-kleinkram-0.4.0.dist-info/entry_points.txt,sha256=RHXtRzcreVHImatgjhQwZQ6GdJThElYjHEWcR1BPXUI,45
-kleinkram-0.4.0.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-kleinkram-0.4.0.dist-info/RECORD,,