kscale 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

kscale/__init__.py

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

kscale/web/cli/robot_class.py

@@ -16,6 +16,11 @@ from kscale.web.gen.api import RobotURDFMetadataInput
 logger = logging.getLogger(__name__)
 
 
+class RobotURDFMetadataInputStrict(RobotURDFMetadataInput):
+    class Config:
+        extra = "forbid"
+
+
 @click.group()
 def cli() -> None:
     """Get information about robot classes."""
@@ -83,7 +88,7 @@ async def update_metadata(name: str, json_path: str) -> None:
     """Updates the metadata of a robot class."""
     with open(json_path, "r", encoding="utf-8") as f:
         raw_metadata = json.load(f)
-    metadata = RobotURDFMetadataInput.model_validate(raw_metadata)
+    metadata = RobotURDFMetadataInputStrict.model_validate(raw_metadata)
     async with RobotClassClient() as client:
         robot_class = await client.update_robot_class(name, new_metadata=metadata)
     click.echo("Robot class metadata updated:")
@@ -91,6 +96,25 @@ async def update_metadata(name: str, json_path: str) -> None:
     click.echo(f"  Name: {click.style(robot_class.class_name, fg='green')}")
 
 
+@cli.command()
+@click.argument("name")
+@click.option("--json-path", type=click.Path(exists=False))
+@coro
+async def get_metadata(name: str, json_path: str | None = None) -> None:
+    """Gets the metadata of a robot class."""
+    async with RobotClassClient() as client:
+        robot_class = await client.get_robot_class(name)
+    metadata = robot_class.metadata
+    if metadata is None:
+        click.echo(click.style("No metadata found", fg="red"))
+        return
+    if json_path is None:
+        click.echo(metadata.model_dump_json(indent=2))
+    else:
+        with open(json_path, "w", encoding="utf-8") as f:
+            json.dump(metadata.model_dump(), f)
+
+
 @cli.command()
 @click.argument("name")
 @coro

kscale/web/clients/robot_class.py

@@ -35,6 +35,14 @@ class RobotClassClient(BaseClient):
         )
         return [RobotClass.model_validate(item) for item in data]
 
+    async def get_robot_class(self, class_name: str) -> RobotClass:
+        data = await self._request(
+            "GET",
+            f"/robots/name/{class_name}",
+            auth=True,
+        )
+        return RobotClass.model_validate(data)
+
     async def create_robot_class(self, class_name: str, description: str | None = None) -> RobotClass:
         data = {}
         if description is not None:

kscale/web/gen/api.py

@@ -2,7 +2,7 @@
 
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2025-01-21T07:10:22+00:00
+#   timestamp: 2025-01-22T04:20:37+00:00
 
 from __future__ import annotations
 
@@ -11,6 +11,10 @@ from typing import Dict, List, Optional, Union
 from pydantic import BaseModel, Field
 
 
+class APIKeyRequest(BaseModel):
+    num_hours: Optional[int] = Field(24, title="Num Hours")
+
+
 class APIKeyResponse(BaseModel):
     api_key: str = Field(..., title="Api Key")
 
@@ -29,8 +33,7 @@ class JointMetadataInput(BaseModel):
     kp: Optional[Union[float, str]] = Field(None, title="Kp")
     kd: Optional[Union[float, str]] = Field(None, title="Kd")
     offset: Optional[Union[float, str]] = Field(None, title="Offset")
-    lower_limit: Optional[Union[float, str]] = Field(None, title="Lower Limit")
-    upper_limit: Optional[Union[float, str]] = Field(None, title="Upper Limit")
+    flipped: Optional[bool] = Field(None, title="Flipped")
 
 
 class JointMetadataOutput(BaseModel):
@@ -38,8 +41,7 @@ class JointMetadataOutput(BaseModel):
     kp: Optional[str] = Field(None, title="Kp")
     kd: Optional[str] = Field(None, title="Kd")
     offset: Optional[str] = Field(None, title="Offset")
-    lower_limit: Optional[str] = Field(None, title="Lower Limit")
-    upper_limit: Optional[str] = Field(None, title="Upper Limit")
+    flipped: Optional[bool] = Field(None, title="Flipped")
 
 
 class OICDInfo(BaseModel):

{kscale-0.3.0.dist-info → kscale-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kscale
-Version: 0.3.0
+Version: 0.3.2
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte

{kscale-0.3.0.dist-info → kscale-0.3.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-kscale/__init__.py,sha256=ApqkdyLhaMQ1u0TopxCm4T5hZTDoweO2b2gUg0djui8,200
+kscale/__init__.py,sha256=kd5GppaQJl10D1iD73gCLOi5akkQ1_cWXXdlx4NMGD8,200
 kscale/cli.py,sha256=PMHLKR5UwdbbReVmqHXpJ-K9-mGHv_0I7KQkwxmFcUA,881
 kscale/conf.py,sha256=dm35XSnzJp93St-ixVtYN4Nvqvb5upPGBrWkSI6Yb-4,1743
 kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -15,20 +15,20 @@ 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=Za5WZmyySgpY-hhR1BqyF1k1wr9bGbXLAE6uFlTOZkk,16706
+kscale/web/cli/robot_class.py,sha256=Gvfg_TsSC0MRUhBIx0yDVXOf8P4kyDbR_glFv5svuDA,17481
 kscale/web/cli/token.py,sha256=1rFC8MYKtqbNsQa2KIqwW1tqpaMtFaxuNsallwejXTU,787
 kscale/web/cli/user.py,sha256=aaJJCL1P5lfhK6ZC9OwOHXKA-I3MWqVZ_k7TYnx33CY,1303
 kscale/web/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/web/clients/base.py,sha256=A70BF9ZnHEBds0RKrowbeUNsX_WwsgV349csUlM4iMc,15174
 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=_oAEUglLmNXCspnACC40XLclLL3Z2rF88o1p0tk-JUM,6588
+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=7Uyzy4V2Ovh70M5lLSaJhwKkBr5SYyTfrNjr180JQhY,4304
-kscale-0.3.0.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
-kscale-0.3.0.dist-info/METADATA,sha256=H3CQZAwUTZBfScRQVKAArLadR62aw-rWhFMUBkTby84,2340
-kscale-0.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kscale-0.3.0.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
-kscale-0.3.0.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
-kscale-0.3.0.dist-info/RECORD,,
+kscale/web/gen/api.py,sha256=PMxBujxwL65yTFL8YIfZXWvcTRsENG0xkmG7kcmfRlw,4224
+kscale-0.3.2.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
+kscale-0.3.2.dist-info/METADATA,sha256=PxUN_QjnqP3Md5VOo6u9apGvEm8pytJmR2sDYfKZ2Qs,2340
+kscale-0.3.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kscale-0.3.2.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
+kscale-0.3.2.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
+kscale-0.3.2.dist-info/RECORD,,