kleinkram 0.0.117__tar.gz → 0.0.118__tar.gz

{kleinkram-0.0.117 → kleinkram-0.0.118}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kleinkram
-Version: 0.0.117
+Version: 0.0.118
 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.0.117 → kleinkram-0.0.118}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "kleinkram"
-version = "0.0.117"
+version = "0.0.118"
 authors = [
   { name="Johann Schwabe", email="jschwab@ethz.ch" },
 ]

{kleinkram-0.0.117 → kleinkram-0.0.118}/src/kleinkram/auth.py

@@ -3,6 +3,8 @@ import os
 import urllib.parse
 import webbrowser
 from http.server import BaseHTTPRequestHandler, HTTPServer
+from typing import Optional
+
 from typing_extensions import Annotated
 
 from pathlib import Path
@@ -139,9 +141,13 @@ client = AuthenticatedClient()
 
 
 def login(
-        key: Annotated[str, typer.Option()] = None,
-        open_browser: Annotated[bool, typer.Option()] = True,
+        key: Optional[str] = typer.Option(None, help="CLI Key", hidden=True),
+        open_browser: Optional[bool] = typer.Option(True, help="Open browser for authentication"),
 ):
+    """
+    Login into the currently set endpoint.\n
+    By default, it will open the browser for authentication. On machines without a browser, you can manually open the URL provided and paste the tokens back.
+    """
     tokenfile = TokenFile()
     if key:
         tokenfile.saveTokens(key)
@@ -181,7 +187,18 @@ def login(
         return
 
 
-def setEndpoint(endpoint: Annotated[str, typer.Argument()]):
+def setEndpoint(
+        endpoint: Optional[str] = typer.Argument(None, help="API endpoint to use")
+):
+    """
+    Set the current endpoint
+
+    Use this command to switch between different API endpoints.\n
+    Standard endpoints are:\n
+    - http://localhost:3000\n
+    - https://api.datasets.leggedrobotics.com\n
+    - https://api.datasets.dev.leggedrobotics.com
+    """
     tokenfile = TokenFile()
     tokenfile.endpoint = endpoint
     tokenfile.writeToFile()
@@ -191,14 +208,27 @@ def setEndpoint(endpoint: Annotated[str, typer.Argument()]):
 
 
 def endpoint():
+    """
+    Get the current endpoint
+
+    Also displays all endpoints with saved tokens.
+    """
     tokenfile = TokenFile()
     print("Current: " + tokenfile.endpoint)
     print("Saved Tokens found for:")
     for _endpoint, _ in tokenfile.tokens.items():
-        print(_endpoint)
+        print("- " + _endpoint)
 
 
-def setCliKey(key: Annotated[str, typer.Argument()]):
+def setCliKey(
+        key: Annotated[str, typer.Argument(help="CLI Key")]
+):
+    """
+    Set the CLI key (Actions Only)
+
+    Same as login with the --key option.
+    Should never be used by the user, only in docker containers launched from within Kleinkram.
+    """
     tokenfile = TokenFile()
     if not tokenfile.endpoint in tokenfile.tokens:
         tokenfile.tokens[tokenfile.endpoint] = {}

kleinkram-0.0.118/src/kleinkram/consts.py

@@ -0,0 +1,2 @@
+API_URL = "http://localhost:3000"
+# API_URL = "https://api.datasets.leggedrobotics.com"

{kleinkram-0.0.117 → kleinkram-0.0.118}/src/kleinkram/main.py

@@ -14,14 +14,14 @@ from .helper import uploadFiles, expand_and_match
 from .auth import login, client, endpoint, setCliKey, setEndpoint
 
 app = typer.Typer()
-projects = typer.Typer(name="projects")
-missions = typer.Typer(name="missions")
-files = typer.Typer(name="files")
-topics = typer.Typer(name="topics")
-queue = typer.Typer(name="queue")
-user = typer.Typer(name="users")
-tagtypes = typer.Typer(name="tagtypes")
-tag = typer.Typer(name="tag")
+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="Queue operations")
+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)
@@ -35,27 +35,38 @@ app.add_typer(tag)
 app.command()(login)
 app.command()(endpoint)
 app.command()(setEndpoint)
-app.command()(setCliKey)
+app.command(hidden=True)(setCliKey)
 
 
 @files.command("list")
 def list_files(
-        project: Annotated[str, typer.Option()] = None,
-        mission: Annotated[str, typer.Option()] = None,
-        topics: Annotated[List[str], typer.Option()] = None,
+        project: Optional[str] = typer.Option(None, help="Name of Project"),
+        mission: Optional[str] = typer.Option(None, help="Name of Mission"),
+        topics: Optional[List[str]] = typer.Option(None, help="Comma separated list of topics")
 ):
     """
     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
         response = client.get(
             url,
-            params={
-                "projectName": project,
-                "missionName": mission,
-                "topics": topics,
-            },
+            params=params,
         )
         response.raise_for_status()
         data = response.json()
@@ -104,11 +115,12 @@ def list_projects():
 
 @missions.command("list")
 def list_missions(
-        project: Annotated[str, typer.Option()] = None,
-        verbose: Annotated[bool, typer.Option()] = False,
+        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"
@@ -152,26 +164,47 @@ def list_missions(
 @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.
+
+    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()
-        print(f"mission: {data['name']}")
-        print(f"Creator: {data['creator']['name']}")
-        table = Table("Filename", "Size", "date")
-        for file in data["files"]:
-            table.add_row(file["filename"], f"{file['size']}", file["date"])
+        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}")
 
 
 @topics.command("list")
 def topics(
-        file: Annotated[str, typer.Option()] = None,
-        full: Annotated[bool, typer.Option()] = False,
+        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
 ):
+    """
+    List topics for a file
+
+    Only makes sense with MCAP files as we don't associate topics with BAGs.
+    """
+    if file.endswith(".bag"):
+        print("BAG files generally do not have topics")
     try:
         url = "/file/byName"
         response = client.get(url, params={"name": file})
@@ -197,11 +230,19 @@ def topics(
 
 
 @projects.command("create")
-def create_project(name: Annotated[str, typer.Option()]):
+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
+    """
     try:
         url = "/project/create"
-        response = client.post(url, json={"name": name})
-        response.raise_for_status()
+        response = client.post(url, json={"name": name, "description": description, "requiredTags": []}) # TODO: Add required tags as option
+        if response.status_code >= 400:
+            print(f"Failed to create project: {response.json()["message"]}")
+            return
         print("Project created")
 
     except httpx.HTTPError as e:
@@ -210,12 +251,23 @@ def create_project(name: Annotated[str, typer.Option()]):
 
 @app.command("upload")
 def upload(
-        path: Annotated[str, typer.Option(prompt=True)],
-        project: Annotated[str, typer.Option(prompt=True)],
-        mission: Annotated[str, typer.Option(prompt=True)],
+        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):
@@ -247,7 +299,7 @@ def upload(
 
         create_mission_url = "/mission/create"
         new_mission = client.post(
-            create_mission_url, json={"name": mission, "projectUUID": project_json["uuid"]}
+            create_mission_url, json={"name": mission, "projectUUID": project_json["uuid"], "tags": []}
         )
         new_mission.raise_for_status()
         new_mission_data = new_mission.json()
@@ -322,7 +374,7 @@ def clear_queue():
         print("Operation cancelled.")
 
 
-@app.command("wipe")
+@app.command("wipe", hidden=True)
 def wipe():
     """Wipe all data"""
     # Prompt the user for confirmation
@@ -362,8 +414,13 @@ def wipe():
         print("Operation cancelled.")
 
 
-@app.command("claim")
+@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.
+    """
     response = client.post("/user/claimAdmin")
     response.raise_for_status()
     print("Admin claimed.")
@@ -371,6 +428,7 @@ def claim():
 
 @user.command("list")
 def users():
+    """List all users"""
     response = client.get("/user/all")
     response.raise_for_status()
     data = response.json()
@@ -382,6 +440,7 @@ def users():
 
 @user.command("info")
 def user_info():
+    """Get logged in user info"""
     response = client.get("/user/me")
     response.raise_for_status()
     data = response.json()
@@ -390,6 +449,7 @@ def user_info():
 
 @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.")
@@ -397,6 +457,7 @@ def promote(email: Annotated[str, typer.Option()]):
 
 @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.")
@@ -406,6 +467,7 @@ def demote(email: Annotated[str, typer.Option()]):
 def download(
         missionuuid: Annotated[str, typer.Argument()],
 ):
+    """Download file"""
     try:
         response = client.get("/file/downloadWithToken", params={"uuid": missionuuid})
         response.raise_for_status()
@@ -419,6 +481,7 @@ def addTag(
         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:
@@ -436,6 +499,7 @@ def addTag(
 def tagTypes(
         verbose: Annotated[bool, typer.Option()] = False,
 ):
+    """List all tagtypes"""
     try:
         response = client.get("/tag/all")
         response.raise_for_status()
@@ -456,6 +520,7 @@ def tagTypes(
 def deleteTag(
         taguuid: Annotated[str, typer.Argument()],
 ):
+    """Delete a tag"""
     try:
         response = client.delete("/tag/deleteTag", params={"uuid": taguuid})
         if response.status_code < 400:

kleinkram-0.0.117/src/kleinkram/consts.py

@@ -1 +0,0 @@
-API_URL='https://api.datasets.leggedrobotics.com'