kscale 0.3.6__py3-none-any.whl → 0.3.8__py3-none-any.whl

kscale/__init__.py

@@ -1,6 +1,6 @@
 """Defines the common interface for the K-Scale Python API."""
 
-__version__ = "0.3.6"
+__version__ = "0.3.8"
 
 from pathlib import Path
 

kscale/cli.py

@@ -8,7 +8,6 @@ import colorlogging
 from kscale.utils.cli import recursive_help
 from kscale.web.cli.robot import cli as robot_cli
 from kscale.web.cli.robot_class import cli as robot_class_cli
-from kscale.web.cli.token import cli as token_cli
 from kscale.web.cli.user import cli as user_cli
 
 
@@ -22,7 +21,6 @@ def cli() -> None:
     logging.getLogger("aiohttp.access").setLevel(logging.WARNING)
 
 
-cli.add_command(token_cli, "token")
 cli.add_command(user_cli, "user")
 cli.add_command(robot_class_cli, "robots")
 cli.add_command(robot_cli, "robot")

kscale/requirements.txt

@@ -21,6 +21,3 @@ tabulate
 
 # Async
 async-lru
-
-# K-Scale
-krec

kscale/web/cli/robot_class.py

@@ -1,5 +1,6 @@
 """Defines the CLI for getting information about robot classes."""
 
+import itertools
 import json
 import logging
 import math
@@ -80,7 +81,23 @@ async def update(current_name: str, name: str | None = None, description: str |
     click.echo(f"  Description: {click.style(robot_class.description or 'N/A', fg='yellow')}")
 
 
-@cli.command()
+@cli.command("delete")
+@click.argument("name")
+@coro
+async def delete_robot_class(name: str) -> None:
+    """Deletes a robot class."""
+    async with RobotClassClient() as client:
+        await client.delete_robot_class(name)
+    click.echo(f"Robot class deleted: {click.style(name, fg='red')}")
+
+
+@cli.group()
+def metadata() -> None:
+    """Handle the robot class metadata."""
+    pass
+
+
+@metadata.command("update")
 @click.argument("name")
 @click.argument("json_path", type=click.Path(exists=True))
 @coro
@@ -96,7 +113,7 @@ async def update_metadata(name: str, json_path: str) -> None:
     click.echo(f"  Name: {click.style(robot_class.class_name, fg='green')}")
 
 
-@cli.command()
+@metadata.command("get")
 @click.argument("name")
 @click.option("--json-path", type=click.Path(exists=False))
 @coro
@@ -115,27 +132,17 @@ async def get_metadata(name: str, json_path: str | None = None) -> None:
             json.dump(metadata.model_dump(), f)
 
 
-@cli.command()
-@click.argument("name")
-@coro
-async def delete(name: str) -> None:
-    """Deletes a robot class."""
-    async with RobotClassClient() as client:
-        await client.delete_robot_class(name)
-    click.echo(f"Robot class deleted: {click.style(name, fg='red')}")
-
-
 @cli.group()
 def urdf() -> None:
     """Handle the robot class URDF."""
     pass
 
 
-@urdf.command()
+@urdf.command("upload")
 @click.argument("class_name")
 @click.argument("urdf_file")
 @coro
-async def upload(class_name: str, urdf_file: str) -> None:
+async def upload_urdf(class_name: str, urdf_file: str) -> None:
     """Uploads a URDF file to a robot class."""
     async with RobotClassClient() as client:
         response = await client.upload_robot_class_urdf(class_name, urdf_file)
@@ -143,18 +150,18 @@ async def upload(class_name: str, urdf_file: str) -> None:
     click.echo(f"  Filename: {click.style(response.filename, fg='green')}")
 
 
-@urdf.command()
+@urdf.command("download")
 @click.argument("class_name")
 @click.option("--cache", is_flag=True, default=False)
 @coro
-async def download(class_name: str, cache: bool) -> None:
+async def download_urdf(class_name: str, cache: bool) -> None:
     """Downloads a URDF file from a robot class."""
     async with RobotClassClient() as client:
         urdf_file = await client.download_and_extract_urdf(class_name, cache=cache)
     click.echo(f"URDF downloaded: {click.style(urdf_file, fg='green')}")
 
 
-@urdf.command()
+@urdf.command("pybullet")
 @click.argument("class_name")
 @click.option("--no-cache", is_flag=True, default=False)
 @click.option("--hide-gui", is_flag=True, default=False)
@@ -168,7 +175,7 @@ async def download(class_name: str, cache: bool) -> None:
 @click.option("--start-height", type=float, default=0.0)
 @click.option("--cycle-duration", type=float, default=2.0)
 @coro
-async def pybullet(
+async def run_pybullet(
     class_name: str,
     no_cache: bool,
     hide_gui: bool,
@@ -432,11 +439,11 @@ async def pybullet(
         last_time = cur_time
 
 
-@urdf.command()
+@urdf.command("mujoco")
 @click.argument("class_name")
 @click.option("--no-cache", is_flag=True, default=False)
 @coro
-async def mujoco(class_name: str, no_cache: bool) -> None:
+async def run_mujoco(class_name: str, no_cache: bool) -> None:
     """Shows the URDF file for a robot class in Mujoco.
 
     This command downloads and extracts the robot class URDF folder,
@@ -444,11 +451,11 @@ async def mujoco(class_name: str, no_cache: bool) -> None:
     launches the Mujoco viewer using the provided MJCF file.
     """
     try:
-        from mujoco.viewer import launch_from_path
+        import mujoco.viewer
     except ImportError:
         click.echo(
             click.style(
-                "Mujoco and mujoco-python-viewer are required; install with `pip install mujoco mujoco-python-viewer`",
+                "Mujoco and mujoco-python-viewer are required; install with `pip install mujoco`",
                 fg="red",
             )
         )
@@ -458,13 +465,20 @@ async def mujoco(class_name: str, no_cache: bool) -> None:
         extracted_folder = await client.download_and_extract_urdf(class_name, cache=not no_cache)
 
     try:
-        mjcf_file = next(extracted_folder.glob("*.mjcf"))
+        mjcf_file = next(
+            itertools.chain(
+                extracted_folder.glob("*.scene.mjcf"),
+                extracted_folder.glob("*.mjcf"),
+                extracted_folder.glob("*.xml"),
+            )
+        )
     except StopIteration:
         click.echo(click.style(f"No MJCF file found in {extracted_folder}", fg="red"))
         return
 
-    click.echo(f"Launching Mujoco viewer with: {click.style(str(mjcf_file.resolve()), fg='green')}")
-    launch_from_path(str(mjcf_file.resolve()))
+    mjcf_path_str = str(mjcf_file.resolve())
+    click.echo(f"Launching Mujoco viewer with: {click.style(mjcf_path_str, fg='green')}")
+    mujoco.viewer.launch_from_path(mjcf_path_str)
 
 
 if __name__ == "__main__":

kscale/web/cli/user.py

@@ -45,8 +45,7 @@ async def key() -> None:
     """Get an API key for the currently-authenticated user."""
     client = UserClient()
     api_key = await client.get_api_key()
-    click.echo("API key:")
-    click.echo(click.style(api_key, fg="green"))
+    click.echo(f"API key: {click.style(api_key, fg='green')}")
 
 
 if __name__ == "__main__":

kscale/web/clients/base.py

@@ -5,6 +5,7 @@ import json
 import logging
 import os
 import secrets
+import sys
 import time
 import webbrowser
 from types import TracebackType
@@ -31,6 +32,10 @@ OAUTH_PORT = 16821
 HEADER_NAME = "x-kscale-api-key"
 
 
+def verbose_error() -> bool:
+    return os.environ.get("KSCALE_VERBOSE_ERROR", "0") == "1"
+
+
 class OAuthCallback:
     def __init__(self) -> None:
         self.token_type: str | None = None
@@ -375,8 +380,14 @@ class BaseClient:
         response = await client.request(method, url, **kwargs)
 
         if response.is_error:
-            logger.error("Error response from K-Scale: %s", response.text)
-        response.raise_for_status()
+            logger.error("Got %d error K-Scale: %s", response.status_code, response.text)
+            if verbose_error():
+                response.raise_for_status()
+            else:
+                logger.error("Use KSCALE_VERBOSE_ERROR=1 to see the full error message")
+                logger.error("If this persists, please create an issue here: https://github.com/kscalelabs/kscale")
+                sys.exit(1)
+
         return response.json()
 
     async def close(self) -> None:

{kscale-0.3.6.dist-info → kscale-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kscale
-Version: 0.3.6
+Version: 0.3.8
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte
@@ -21,7 +21,6 @@ Requires-Dist: click
 Requires-Dist: colorlogging
 Requires-Dist: tabulate
 Requires-Dist: async-lru
-Requires-Dist: krec
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: darglint; extra == "dev"

{kscale-0.3.6.dist-info → kscale-0.3.8.dist-info}/RECORD

@@ -1,9 +1,9 @@
-kscale/__init__.py,sha256=ny2947fOKliAIcJrudjMn6Ocfzk9Hb-VXUNFPikAPGo,200
-kscale/cli.py,sha256=PMHLKR5UwdbbReVmqHXpJ-K9-mGHv_0I7KQkwxmFcUA,881
+kscale/__init__.py,sha256=XbIxlxq1doXA2L5v8II07s5g2CoqvIRp8LT5AfdFJDY,200
+kscale/cli.py,sha256=JvaPtmWvF7s0D4I3K98eZAItf3oOi2ULsn5aPGxDcu4,795
 kscale/conf.py,sha256=dm35XSnzJp93St-ixVtYN4Nvqvb5upPGBrWkSI6Yb-4,1743
 kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/requirements-dev.txt,sha256=WI7-ea4IRJakmqVMN8QKhOsDGrghwtvk03aIsFaNSIw,130
-kscale/requirements.txt,sha256=_BGbnKTQaXKx0bNEG0wguod9swsiCb2mF6rLm7sFJ2Q,214
+kscale/requirements.txt,sha256=tj8wBkIhl6ijk5rFqtPCdkpdOS7XSIcUvsz_Eq1axcw,198
 kscale/artifacts/__init__.py,sha256=RK8wdybtCJPgdLLJ8R8-YMi1Ph5ojqAKVJZowHONtgo,232
 kscale/artifacts/plane.obj,sha256=x59-IIrWpLjhotChiqT2Ul6U8s0RcHkaEeUZb4KXL1c,348
 kscale/artifacts/plane.urdf,sha256=LCiTk14AyTHjkZ1jvsb0hNaEaJUxDb8Z1JjsgpXu3YM,819
@@ -15,20 +15,19 @@ kscale/web/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/web/utils.py,sha256=Mme-FAQ0_zbjjOQeX8wyq8F4kL4i9fH7ytri16U6qOA,1046
 kscale/web/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/web/cli/robot.py,sha256=rI-A4_0uvJPeA71Apl4Z3mV5fIfWkgmzT9JRmJYxz3A,3307
-kscale/web/cli/robot_class.py,sha256=Ymyrc3UqsO7PzP_wJFXEWW37knMCDZTYP-8ziXVa-AQ,18710
-kscale/web/cli/token.py,sha256=1rFC8MYKtqbNsQa2KIqwW1tqpaMtFaxuNsallwejXTU,787
-kscale/web/cli/user.py,sha256=aaJJCL1P5lfhK6ZC9OwOHXKA-I3MWqVZ_k7TYnx33CY,1303
+kscale/web/cli/robot_class.py,sha256=Vg-KWROdmz3yqBEG-RS5xiUviKwEz8DZ3q2estK66ZQ,19082
+kscale/web/cli/user.py,sha256=9IGsJBPyhjsmT04mZ2RGOs35ePfqB2RltYP0Ty5zF5o,1290
 kscale/web/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/web/clients/base.py,sha256=A70BF9ZnHEBds0RKrowbeUNsX_WwsgV349csUlM4iMc,15174
+kscale/web/clients/base.py,sha256=ThQakuvGh7CquiGQ4wiCyCWAgqmKInsJcANo910X9Uw,15585
 kscale/web/clients/client.py,sha256=rzW2s8T7bKVuybOSQ65-ghl02rcXBoOxnx_nUDwgEPw,362
 kscale/web/clients/robot.py,sha256=PI8HHkU-4Re9I5rLpp6dGbekRE-rBNVfXZxR_mO2MqE,1485
 kscale/web/clients/robot_class.py,sha256=G8Nk6V7LGJE9Wpg9tyyCkIfz1fRTsxXQRgHtleiUVqo,6834
 kscale/web/clients/user.py,sha256=jsa1_s6qXRM-AGBbHlPhd1NierUtynjY9tVAPNr6_Os,568
 kscale/web/gen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/web/gen/api.py,sha256=VWlt8TaMZaAhCPPIWhx1d4yE0BRfpVz0-_Cps8hjgAI,4662
-kscale-0.3.6.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
-kscale-0.3.6.dist-info/METADATA,sha256=IHjwsym9rqmZnPltfYE3nGywHbDFR-HCOVfh_YrG_Bg,2340
-kscale-0.3.6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kscale-0.3.6.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
-kscale-0.3.6.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
-kscale-0.3.6.dist-info/RECORD,,
+kscale-0.3.8.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
+kscale-0.3.8.dist-info/METADATA,sha256=b2ThYIovV2vTrR_uU44Hl4VHWKZEJkNJa56_1VqyvrE,2320
+kscale-0.3.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kscale-0.3.8.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
+kscale-0.3.8.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
+kscale-0.3.8.dist-info/RECORD,,

kscale/web/cli/token.py

@@ -1,33 +0,0 @@
-"""Defines the CLI for interacting with K-Scale's OpenID Connect server."""
-
-import logging
-
-import click
-
-from kscale.utils.cli import coro
-from kscale.web.clients.base import BaseClient
-
-logger = logging.getLogger(__name__)
-
-
-@click.group()
-def cli() -> None:
-    """Retrieve an OICD token from the K-Scale authentication server."""
-    pass
-
-
-@cli.command()
-@coro
-async def get() -> None:
-    """Get a bearer token from OpenID Connect."""
-    logging.getLogger("aiohttp.access").setLevel(logging.WARNING)
-    async with BaseClient() as client:
-        try:
-            token = await client.get_bearer_token()
-            logger.info("Bearer token: %s", token)
-        except Exception:
-            logger.exception("Error getting bearer token")
-
-
-if __name__ == "__main__":
-    cli()