kscale 0.1.5__py3-none-any.whl → 0.2.1__py3-none-any.whl

kscale/__init__.py

@@ -1,9 +1,9 @@
 """Defines the common interface for the K-Scale Python API."""
 
-__version__ = "0.1.5"
+__version__ = "0.2.1"
 
 from pathlib import Path
 
-from kscale.api import K
+from kscale.web.clients.client import WWWClient as K
 
 ROOT_DIR = Path(__file__).parent

kscale/web/cli/robot_class.py

@@ -105,7 +105,7 @@ async def upload(class_name: str, urdf_file: str) -> None:
 async def download(class_name: str, no_cache: bool) -> None:
     """Downloads a URDF file from a robot class."""
     async with RobotClassClient() as client:
-        urdf_file = await client.download_robot_class_urdf(class_name, cache=not no_cache)
+        urdf_file = await client.download_compressed_urdf(class_name, cache=not no_cache)
     click.echo(f"URDF downloaded: {click.style(urdf_file, fg='green')}")
 
 

kscale/web/clients/client.py

@@ -1,10 +1,14 @@
 """Defines a unified client for the K-Scale WWW API."""
 
 from kscale.web.clients.base import BaseClient
+from kscale.web.clients.robot import RobotClient
+from kscale.web.clients.robot_class import RobotClassClient
 from kscale.web.clients.user import UserClient
 
 
 class WWWClient(
+    RobotClient,
+    RobotClassClient,
     UserClient,
     BaseClient,
 ):

kscale/web/clients/robot_class.py

@@ -21,6 +21,8 @@ logger = logging.getLogger(__name__)
 UPLOAD_TIMEOUT = 300.0
 DOWNLOAD_TIMEOUT = 60.0
 
+INFO_FILE_NAME = ".info.json"
+
 
 class RobotClassClient(BaseClient):
     async def get_robot_classes(self) -> list[RobotClass]:
@@ -98,7 +100,7 @@ class RobotClassClient(BaseClient):
                 r.raise_for_status()
         return response
 
-    async def download_robot_class_urdf(self, class_name: str, *, cache: bool = True) -> Path:
+    async def download_compressed_urdf(self, class_name: str, *, cache: bool = True) -> Path:
         cache_path = get_robots_dir() / class_name / "robot.tgz"
         if cache and cache_path.exists() and not should_refresh_file(cache_path):
             return cache_path
@@ -108,7 +110,7 @@ class RobotClassClient(BaseClient):
         cache_path.parent.mkdir(parents=True, exist_ok=True)
 
         # Checks the md5 hash of the file.
-        cache_path_info = cache_path.parent / "info.json"
+        cache_path_info = cache_path.parent / INFO_FILE_NAME
         if cache_path_info.exists():
             with open(cache_path_info, "r") as f:
                 info = json.load(f)
@@ -133,13 +135,42 @@ class RobotClassClient(BaseClient):
         if hash_value_hex != expected_hash:
             raise ValueError(f"MD5 hash mismatch: {hash_value_hex} != {expected_hash}")
 
-        logger.info("Unpacking downloaded file")
-        with tarfile.open(cache_path, "r:gz") as tar:
-            tar.extractall(path=cache_path.parent)
-
         logger.info("Updating downloaded file information")
         info = {"md5_hash": hash_value_hex}
         with open(cache_path_info, "w") as f:
             json.dump(info, f)
 
         return cache_path
+
+    async def download_and_extract_urdf(self, class_name: str, *, cache: bool = True) -> Path:
+        cache_path = await self.download_compressed_urdf(class_name, cache=cache)
+
+        # Reads the MD5 hash from the info file.
+        cache_path_info = cache_path.parent / INFO_FILE_NAME
+        with open(cache_path_info, "r") as f:
+            info = json.load(f)
+            expected_hash = info["md5_hash"]
+
+        # Unpacks the file if requested.
+        unpack_path = cache_path.parent / "robot"
+        unpack_path.mkdir(parents=True, exist_ok=True)
+        unpacked_path_info = unpack_path / INFO_FILE_NAME
+
+        # If the file has already been unpacked, return the path.
+        if unpacked_path_info.exists():
+            with open(unpacked_path_info, "r") as f:
+                info = json.load(f)
+                if info["md5_hash"] == expected_hash:
+                    unpack_path.touch()
+                    return unpack_path
+
+        logger.info("Unpacking URDF file")
+        with tarfile.open(cache_path, "r:gz") as tar:
+            tar.extractall(path=unpack_path)
+
+        logger.info("Updating downloaded file information")
+        info = {"md5_hash": expected_hash}
+        with open(unpacked_path_info, "w") as f:
+            json.dump(info, f)
+
+        return unpack_path

{kscale-0.1.5.dist-info → kscale-0.2.1.dist-info}/METADATA

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

{kscale-0.1.5.dist-info → kscale-0.2.1.dist-info}/RECORD

@@ -1,5 +1,4 @@
-kscale/__init__.py,sha256=SnUAXz1ZDSR98-rg2Ne7pAF7YPDh5i3v3EyoZxR3l-4,172
-kscale/api.py,sha256=jmiuFurTN_Gj_-k-6asqxw8wp-_bgJUXgMPFgJ4lqHA,230
+kscale/__init__.py,sha256=73uaPK_Lj05TFJYmYf9BjFp9JHB5XKLlMIwORoDZpx0,200
 kscale/cli.py,sha256=PMHLKR5UwdbbReVmqHXpJ-K9-mGHv_0I7KQkwxmFcUA,881
 kscale/conf.py,sha256=OLGz2J-9NAaICoWeN9-hCxrOsyf0vpJBNw-UzIsHdwE,1572
 kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -13,24 +12,23 @@ kscale/utils/api_base.py,sha256=Kk_WtRDdJHmOg6NtHmVxVrcfARSUkhfr29ypLch_pO0,112
 kscale/utils/checksum.py,sha256=jt6QmmQND9zrOEnUtOfZpLYROhgto4Gh3OpdUWk4tZA,1093
 kscale/utils/cli.py,sha256=JoaY5x5SdUx97KmMM9j5AjRRUqqrTlJ9qVckZptEsYA,827
 kscale/web/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/web/api.py,sha256=oyW0XLfX96RPe1xNgdf8ejfATdLlNlP0CL1lP0FN1nM,593
 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=ymC5phUqofvOXv5P6f51b9lMK5eRDaavvnzS0x9rDbU,3574
+kscale/web/cli/robot_class.py,sha256=8igY6oWUDafb644QzmqC5cX6Az0rNJau_jvLr7YkCd0,3573
 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=uovIxtkotRxrIFL0PhLYDIhhfXrIGjXxNY2FLVO3L18,15110
-kscale/web/clients/client.py,sha256=QjBicdHQYNoUG9XRjAYmGu3THae9DzWa_hQox3OO1Gw,214
+kscale/web/clients/client.py,sha256=rzW2s8T7bKVuybOSQ65-ghl02rcXBoOxnx_nUDwgEPw,362
 kscale/web/clients/robot.py,sha256=HMfJnkDxaJ_o7X2vdYYS9iob1JRoBG2qiGmQpCQZpAk,1485
-kscale/web/clients/robot_class.py,sha256=O_6lAKAcdNGFVtojuiQlgPCVP5MQlYPZG5Z-awwauho,5206
+kscale/web/clients/robot_class.py,sha256=zCFL-Y_jIfO9_qOwzBAHzfgFxzpltMte4LM5haCC24U,6385
 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=SovcII36JFgK9jd2CXlLPMjiUROGB4vEnapOsYMUrkU,2188
-kscale-0.1.5.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
-kscale-0.1.5.dist-info/METADATA,sha256=kTsVXOA7Zh2m_eqBm2iaxanfL92BNpPadsC-vasZ018,2340
-kscale-0.1.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kscale-0.1.5.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
-kscale-0.1.5.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
-kscale-0.1.5.dist-info/RECORD,,
+kscale-0.2.1.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
+kscale-0.2.1.dist-info/METADATA,sha256=IeSxq7ApAKrn48Xep-kRu-wQpOq14y_M3GbUgcpHbJE,2340
+kscale-0.2.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kscale-0.2.1.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
+kscale-0.2.1.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
+kscale-0.2.1.dist-info/RECORD,,

kscale/api.py

@@ -1,11 +0,0 @@
-"""Defines common functionality for the K-Scale API."""
-
-from kscale.utils.api_base import APIBase
-from kscale.web.api import WebAPI
-
-
-class K(
-    WebAPI,
-    APIBase,
-):
-    """Defines a common interface for the K-Scale API."""

kscale/web/api.py

@@ -1,18 +0,0 @@
-"""Defines a common interface for the K-Scale WWW API."""
-
-from kscale.utils.api_base import APIBase
-from kscale.web.clients.client import WWWClient
-from kscale.web.gen.api import ProfileResponse
-
-
-class WebAPI(APIBase):
-    async def www_client(self) -> WWWClient:
-        return WWWClient()
-
-    async def get_profile_info(self) -> ProfileResponse:
-        client = await self.www_client()
-        return await client.get_profile_info()
-
-    async def get_api_key(self, num_hours: int = 24) -> str:
-        client = await self.www_client()
-        return await client.get_api_key(num_hours)