kscale 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

kscale/__init__.py

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

kscale/conf.py

@@ -22,6 +22,7 @@ def get_path() -> Path:
 class WWWSettings:
     api_root: str = field(default=DEFAULT_API_ROOT)
     cache_dir: str = field(default=II("oc.env:KSCALE_CACHE_DIR,'~/.kscale/cache/'"))
+    refresh_interval_minutes: int = field(default=60 * 24)
 
 
 @dataclass

kscale/requirements.txt

@@ -3,7 +3,6 @@
 # Configuration
 omegaconf
 email_validator
-colorlogging
 
 # HTTP requests
 aiohttp
@@ -17,6 +16,7 @@ yarl
 # CLI
 aiofiles
 click
+colorlogging
 tabulate
 
 # Async

kscale/web/clients/robot_class.py

@@ -1,6 +1,7 @@
 """Defines the client for interacting with the K-Scale robot class endpoints."""
 
 import hashlib
+import json
 import logging
 from pathlib import Path
 
@@ -8,10 +9,13 @@ import httpx
 
 from kscale.web.clients.base import BaseClient
 from kscale.web.gen.api import RobotClass, RobotDownloadURDFResponse, RobotUploadURDFResponse
-from kscale.web.utils import get_cache_dir
+from kscale.web.utils import get_cache_dir, should_refresh_file
 
 logger = logging.getLogger(__name__)
 
+UPLOAD_TIMEOUT = 300.0
+DOWNLOAD_TIMEOUT = 60.0
+
 
 class RobotClassClient(BaseClient):
     async def get_robot_classes(self) -> list[RobotClass]:
@@ -77,7 +81,9 @@ class RobotClassClient(BaseClient):
             auth=True,
         )
         response = RobotUploadURDFResponse.model_validate(data)
-        async with httpx.AsyncClient() as client:
+        async with httpx.AsyncClient(
+            timeout=httpx.Timeout(UPLOAD_TIMEOUT),
+        ) as client:
             async with client.stream(
                 "PUT",
                 response.url,
@@ -89,15 +95,26 @@ class RobotClassClient(BaseClient):
 
     async def download_robot_class_urdf(self, class_name: str, *, cache: bool = True) -> Path:
         cache_path = get_cache_dir() / class_name / "robot.tgz"
-        if cache and cache_path.exists():
+        if cache and cache_path.exists() and not should_refresh_file(cache_path):
             return cache_path
         data = await self._request("GET", f"/robots/urdf/{class_name}", auth=True)
         response = RobotDownloadURDFResponse.model_validate(data)
         expected_hash = response.md5_hash
         cache_path.parent.mkdir(parents=True, exist_ok=True)
 
+        # Checks the md5 hash of the file.
+        cache_path_info = cache_path.parent / "info.json"
+        if cache_path_info.exists():
+            with open(cache_path_info, "r") as f:
+                info = json.load(f)
+                if info["md5_hash"] == expected_hash:
+                    cache_path.touch()
+                    return cache_path
+
         logger.info("Downloading URDF file from %s", response.url)
-        async with httpx.AsyncClient() as client:
+        async with httpx.AsyncClient(
+            timeout=httpx.Timeout(DOWNLOAD_TIMEOUT),
+        ) as client:
             with open(cache_path, "wb") as file:
                 hash_value = hashlib.md5()
                 async with client.stream("GET", response.url) as r:
@@ -111,4 +128,10 @@ class RobotClassClient(BaseClient):
         if hash_value_hex != expected_hash:
             raise ValueError(f"MD5 hash mismatch: {hash_value_hex} != {expected_hash}")
 
+        # Updates the info file.
+        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

kscale/web/utils.py

@@ -2,6 +2,7 @@
 
 import functools
 import logging
+import time
 from pathlib import Path
 
 from kscale.conf import Settings
@@ -17,6 +18,11 @@ def get_cache_dir() -> Path:
     return Path(Settings.load().www.cache_dir).expanduser().resolve()
 
 
+def should_refresh_file(file: Path) -> bool:
+    """Returns whether the file should be refreshed."""
+    return file.exists() and file.stat().st_mtime < time.time() - Settings.load().www.refresh_interval_minutes * 60
+
+
 @functools.lru_cache
 def get_artifact_dir(artifact_id: str) -> Path:
     """Returns the directory for a specific artifact."""

{kscale-0.1.0.dist-info → kscale-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kscale
-Version: 0.1.0
+Version: 0.1.2
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte
@@ -9,7 +9,6 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: omegaconf
 Requires-Dist: email_validator
-Requires-Dist: colorlogging
 Requires-Dist: aiohttp
 Requires-Dist: cryptography
 Requires-Dist: httpx
@@ -19,6 +18,7 @@ Requires-Dist: requests
 Requires-Dist: yarl
 Requires-Dist: aiofiles
 Requires-Dist: click
+Requires-Dist: colorlogging
 Requires-Dist: tabulate
 Requires-Dist: async-lru
 Requires-Dist: krec

{kscale-0.1.0.dist-info → kscale-0.1.2.dist-info}/RECORD

@@ -1,10 +1,10 @@
-kscale/__init__.py,sha256=2jGtLxds4EdX8FEGT3yA74b0VgrkOEBx_PxiWvoh924,172
+kscale/__init__.py,sha256=Do_oyhXSMNLURbvLDeTx4nJqgYgPhuREBynKDoeJyX4,172
 kscale/api.py,sha256=jmiuFurTN_Gj_-k-6asqxw8wp-_bgJUXgMPFgJ4lqHA,230
 kscale/cli.py,sha256=PMHLKR5UwdbbReVmqHXpJ-K9-mGHv_0I7KQkwxmFcUA,881
-kscale/conf.py,sha256=i5gDTs8D73l2OvX4pOlPWtT2PC26MmoKw3PPwf8HM7U,1526
+kscale/conf.py,sha256=x9jJ8pmSweUsLScN741B21SySCrnRZioV-1ZkhmERbI,1585
 kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/requirements-dev.txt,sha256=WI7-ea4IRJakmqVMN8QKhOsDGrghwtvk03aIsFaNSIw,130
-kscale/requirements.txt,sha256=lKDpyebp9nHZ2uHIuS6FQ6SAg7YO_0sDyb67MFmP4h4,214
+kscale/requirements.txt,sha256=_BGbnKTQaXKx0bNEG0wguod9swsiCb2mF6rLm7sFJ2Q,214
 kscale/artifacts/__init__.py,sha256=RK8wdybtCJPgdLLJ8R8-YMi1Ph5ojqAKVJZowHONtgo,232
 kscale/artifacts/plane.obj,sha256=x59-IIrWpLjhotChiqT2Ul6U8s0RcHkaEeUZb4KXL1c,348
 kscale/artifacts/plane.urdf,sha256=LCiTk14AyTHjkZ1jvsb0hNaEaJUxDb8Z1JjsgpXu3YM,819
@@ -14,7 +14,7 @@ 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=YioIdruq7LCKSBf9SvOGkv914W36_zBmpTzsJqKc0wE,439
-kscale/web/utils.py,sha256=KFB9lrgn_2BRY38Sfbb_QOKZ8fWyINqIqLPwN0rjbyk,806
+kscale/web/utils.py,sha256=l_m8GETCThhnXbHfXq53j1b-E__uZ5GuUbsQ8HR0WA0,1037
 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
@@ -24,13 +24,13 @@ kscale/web/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 kscale/web/clients/base.py,sha256=NRqRH2JTXjJLUMDM93txKgwFu9bQRYhCYLYy7vE76Ik,11462
 kscale/web/clients/client.py,sha256=QjBicdHQYNoUG9XRjAYmGu3THae9DzWa_hQox3OO1Gw,214
 kscale/web/clients/robot.py,sha256=HMfJnkDxaJ_o7X2vdYYS9iob1JRoBG2qiGmQpCQZpAk,1485
-kscale/web/clients/robot_class.py,sha256=yC0G4pVPDoEskf0QfQLxejyDgHLT8gR1RLJ8ioCGoOM,4236
+kscale/web/clients/robot_class.py,sha256=vFXlvwQBmt7zEOixAI-mByBEkXCMZIW5OZjiESMavps,5050
 kscale/web/clients/user.py,sha256=9iv8J-ROm_yBIwi-0oqldReLkNBFktdHRv3UCOxBzjY,377
 kscale/web/gen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/web/gen/api.py,sha256=SovcII36JFgK9jd2CXlLPMjiUROGB4vEnapOsYMUrkU,2188
-kscale-0.1.0.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
-kscale-0.1.0.dist-info/METADATA,sha256=EBGeAHNhtgjRQ38M_3n_mQ1LFlaogmA3qgUsVa45zEA,2340
-kscale-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kscale-0.1.0.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
-kscale-0.1.0.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
-kscale-0.1.0.dist-info/RECORD,,
+kscale-0.1.2.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
+kscale-0.1.2.dist-info/METADATA,sha256=YEcA0zqZwXvW9BnfZn51PrTXcwemCxMuolC1jB7NG-g,2340
+kscale-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kscale-0.1.2.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
+kscale-0.1.2.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
+kscale-0.1.2.dist-info/RECORD,,