kscale 0.2.0__tar.gz → 0.2.1__tar.gz

{kscale-0.2.0/kscale.egg-info → kscale-0.2.1}/PKG-INFO

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

{kscale-0.2.0 → kscale-0.2.1}/kscale/__init__.py

@@ -1,9 +1,9 @@
 """Defines the common interface for the K-Scale Python API."""
 
-__version__ = "0.2.0"
+__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-0.2.0 → kscale-0.2.1}/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-0.2.0 → kscale-0.2.1}/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-0.2.0 → kscale-0.2.1}/kscale/web/clients/robot_class.py

@@ -3,6 +3,7 @@
 import hashlib
 import json
 import logging
+import tarfile
 from pathlib import Path
 
 import httpx
@@ -20,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]:
@@ -97,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
@@ -107,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)
@@ -138,3 +141,36 @@ class RobotClassClient(BaseClient):
             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.2.0 → kscale-0.2.1/kscale.egg-info}/PKG-INFO

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

{kscale-0.2.0 → kscale-0.2.1}/kscale.egg-info/SOURCES.txt

@@ -4,7 +4,6 @@ README.md
 pyproject.toml
 setup.py
 kscale/__init__.py
-kscale/api.py
 kscale/cli.py
 kscale/conf.py
 kscale/py.typed
@@ -25,7 +24,6 @@ kscale/utils/api_base.py
 kscale/utils/checksum.py
 kscale/utils/cli.py
 kscale/web/__init__.py
-kscale/web/api.py
 kscale/web/utils.py
 kscale/web/cli/__init__.py
 kscale/web/cli/robot.py

kscale-0.2.0/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-0.2.0/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)