kleinkram 0.0.120__tar.gz → 0.0.121.dev20240731111552__tar.gz

{kleinkram-0.0.120 → kleinkram-0.0.121.dev20240731111552}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: kleinkram
-Version: 0.0.120
+Version: 0.0.121.dev20240731111552
 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.120 → kleinkram-0.0.121.dev20240731111552}/pyproject.toml

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

{kleinkram-0.0.120 → kleinkram-0.0.121.dev20240731111552}/src/kleinkram/auth.py

@@ -94,7 +94,9 @@ class AuthenticatedClient(httpx.Client):
             self.tokenfile = TokenFile()
             self._load_cookies()
         except Exception as e:
-            print(f"{self.tokenfile.endpoint} is not authenticated. Please run 'klein login'.")
+            print(
+                f"{self.tokenfile.endpoint} is not authenticated. Please run 'klein login'."
+            )
 
     def _load_cookies(self):
         if self.tokenfile.isCliToken():
@@ -110,7 +112,10 @@ class AuthenticatedClient(httpx.Client):
         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, )
+        self.cookies.set(
+            REFRESH_TOKEN,
+            refresh_token,
+        )
         response = self.post(
             "/auth/refresh-token",
         )
@@ -124,16 +129,16 @@ class AuthenticatedClient(httpx.Client):
         response = super().request(
             method, self.tokenfile.endpoint + url, *args, **kwargs
         )
-        if (
-                url == "/auth/refresh-token"
-        ) and response.status_code == 401:
+        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)
+            response = super().request(
+                method, self.tokenfile.endpoint + url, *args, **kwargs
+            )
         return response
 
 
@@ -141,8 +146,10 @@ client = AuthenticatedClient()
 
 
 def login(
-        key: Optional[str] = typer.Option(None, help="CLI Key", hidden=True),
-        open_browser: Optional[bool] = typer.Option(True, help="Open browser for authentication"),
+    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
@@ -175,12 +182,16 @@ def login(
 
             return
 
-        print(f"Please open the following URL manually in your browser to authenticate: {url + '-no-redirect'}")
+        print(
+            f"Please open the following URL manually in your browser to authenticate: {url + '-no-redirect'}"
+        )
         print("Enter the authentication token provided after logging in:")
         manual_auth_token = input("Authentication Token: ")
         manual_refresh_token = input("Refresh Token: ")
         if manual_auth_token:
-            tokenfile.saveTokens({AUTH_TOKEN: manual_auth_token, REFRESH_TOKEN: manual_refresh_token})
+            tokenfile.saveTokens(
+                {AUTH_TOKEN: manual_auth_token, REFRESH_TOKEN: manual_refresh_token}
+            )
             print("Authentication complete. Tokens saved to tokens.json.")
         else:
             print("No authentication token provided.")
@@ -188,7 +199,7 @@ def login(
 
 
 def setEndpoint(
-        endpoint: Optional[str] = typer.Argument(None, help="API endpoint to use")
+    endpoint: Optional[str] = typer.Argument(None, help="API endpoint to use")
 ):
     """
     Set the current endpoint
@@ -220,9 +231,7 @@ def endpoint():
         print("- " + _endpoint)
 
 
-def setCliKey(
-        key: Annotated[str, typer.Argument(help="CLI Key")]
-):
+def setCliKey(key: Annotated[str, typer.Argument(help="CLI Key")]):
     """
     Set the CLI key (Actions Only)
 

kleinkram-0.0.121.dev20240731111552/src/kleinkram/consts.py

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

{kleinkram-0.0.120 → kleinkram-0.0.121.dev20240731111552}/src/kleinkram/helper.py

@@ -56,7 +56,9 @@ def uploadFile(_queue: queue.Queue, paths: Dict[str, str], pbar: tqdm):
                         pbar.update(100)  # Update progress for each file
                         client.post("/queue/confirmUpload", json={"uuid": uuid})
                     else:
-                        print(f"Failed to upload {filename}. HTTP status: {response.status_code}")
+                        print(
+                            f"Failed to upload {filename}. HTTP status: {response.status_code}"
+                        )
             _queue.task_done()
         except queue.Empty:
             break

{kleinkram-0.0.120 → kleinkram-0.0.121.dev20240731111552}/src/kleinkram/main.py

@@ -18,7 +18,7 @@ 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")
+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")
@@ -40,9 +40,11 @@ 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[List[str]] = typer.Option(None, help="Comma separated list of topics")
+    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.
@@ -115,12 +117,13 @@ def list_projects():
 
 @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"),
+    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"
@@ -141,7 +144,9 @@ def list_missions(
         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']}")
+                print(
+                    f"* {missions_by_project_uuid[project_uuid][0]['project']['name']}"
+                )
                 for mission in missions:
                     print(f"  - {mission['name']}")
         else:
@@ -163,8 +168,8 @@ 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"),
+    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
@@ -194,14 +199,16 @@ def mission_by_uuid(
 
 @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
+    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.
+    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")
@@ -231,15 +238,18 @@ def topics(
 
 @projects.command("create")
 def create_project(
-        name: Annotated[str, typer.Option(help="Name of Project")],
-        description: Annotated[str, typer.Option(help="Description of 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
+        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"]
@@ -253,9 +263,13 @@ def create_project(
 
 @app.command("upload")
 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")],
+    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.
@@ -266,7 +280,9 @@ def upload(
 
     """
     files = expand_and_match(path)
-    filenames = list(map(lambda x: x.split("/")[-1], filter(lambda x: not os.path.isdir(x),files)))
+    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
@@ -301,7 +317,8 @@ def upload(
 
         create_mission_url = "/mission/create"
         new_mission = client.post(
-            create_mission_url, json={"name": mission, "projectUUID": project_json["uuid"], "tags": []}
+            create_mission_url,
+            json={"name": mission, "projectUUID": project_json["uuid"], "tags": []},
         )
         new_mission.raise_for_status()
         new_mission_data = new_mission.json()
@@ -467,7 +484,7 @@ def demote(email: Annotated[str, typer.Option()]):
 
 @files.command("download")
 def download(
-        missionuuid: Annotated[str, typer.Argument()],
+    missionuuid: Annotated[str, typer.Argument()],
 ):
     """Download file"""
     try:
@@ -477,15 +494,19 @@ def download(
     except:
         print("Failed to download file")
 
-@missions.command('tag')
+
+@missions.command("tag")
 def addTag(
-        missionuuid: Annotated[str, typer.Argument()],
-        tagtypeuuid: Annotated[str, typer.Argument()],
-        value: Annotated[str, typer.Argument()],
+    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})
+        response = client.post(
+            "/tag/addTag",
+            json={"mission": missionuuid, "tagType": tagtypeuuid, "value": value},
+        )
         if response.status_code < 400:
             print("Tagged mission")
         else:
@@ -497,9 +518,9 @@ def addTag(
         sys.exit(1)
 
 
-@tagtypes.command('list')
+@tagtypes.command("list")
 def tagTypes(
-        verbose: Annotated[bool, typer.Option()] = False,
+    verbose: Annotated[bool, typer.Option()] = False,
 ):
     """List all tagtypes"""
     try:
@@ -507,7 +528,7 @@ def tagTypes(
         response.raise_for_status()
         data = response.json()
         if verbose:
-            table = Table("UUID","Name", "Datatype")
+            table = Table("UUID", "Name", "Datatype")
             for tagtype in data:
                 table.add_row(tagtype["uuid"], tagtype["name"], tagtype["datatype"])
         else:
@@ -518,9 +539,10 @@ def tagTypes(
     except:
         print("Failed to fetch tagtypes")
 
-@tag.command('delete')
+
+@tag.command("delete")
 def deleteTag(
-        taguuid: Annotated[str, typer.Argument()],
+    taguuid: Annotated[str, typer.Argument()],
 ):
     """Delete a tag"""
     try:
@@ -531,8 +553,7 @@ def deleteTag(
             print(response)
             print("Failed to delete tag")
     except:
-        print("Failed to delete tag"
-)
+        print("Failed to delete tag")
 
 
 if __name__ == "__main__":

kleinkram-0.0.120/src/kleinkram/consts.py

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