kscale 0.0.5__py3-none-any.whl → 0.0.7__py3-none-any.whl

kscale/__init__.py

@@ -1,5 +1,5 @@
 """Defines the common interface for the K-Scale Python API."""
 
-__version__ = "0.0.5"
+__version__ = "0.0.7"
 
 from kscale.api import KScale

kscale/store/api.py

@@ -2,7 +2,8 @@
 
 from pathlib import Path
 
-from kscale.store.urdf import download_urdf
+from kscale.store.gen.api import UploadArtifactResponse
+from kscale.store.urdf import download_urdf, upload_urdf
 from kscale.utils.api_base import APIBase
 
 
@@ -18,3 +19,6 @@ class StoreAPI(APIBase):
 
     async def urdf(self, artifact_id: str) -> Path:
         return await download_urdf(artifact_id)
+
+    async def upload_urdf(self, listing_id: str, root_dir: Path) -> UploadArtifactResponse:
+        return await upload_urdf(listing_id, root_dir)

kscale/store/client.py

@@ -1,6 +1,7 @@
 """Defines a typed client for the K-Scale Store API."""
 
 import logging
+from pathlib import Path
 from types import TracebackType
 from typing import Any, Dict, Type
 from urllib.parse import urljoin
@@ -14,17 +15,18 @@ from kscale.store.gen.api import (
     SingleArtifactResponse,
     UploadArtifactResponse,
 )
-from kscale.store.utils import API_ROOT, get_api_key
+from kscale.store.utils import get_api_key, get_api_root
 
 logger = logging.getLogger(__name__)
 
 
 class KScaleStoreClient:
-    def __init__(self, base_url: str = API_ROOT) -> None:
+    def __init__(self, base_url: str = get_api_root()) -> None:
         self.base_url = base_url
         self.client = httpx.AsyncClient(
             base_url=self.base_url,
             headers={"Authorization": f"Bearer {get_api_key()}"},
+            timeout=httpx.Timeout(30.0),
         )
 
     async def _request(
@@ -55,8 +57,9 @@ class KScaleStoreClient:
         return SingleArtifactResponse(**data)
 
     async def upload_artifact(self, listing_id: str, file_path: str) -> UploadArtifactResponse:
+        file_name = Path(file_path).name
         with open(file_path, "rb") as f:
-            files = {"files": (f.name, f, "application/gzip")}
+            files = {"files": (file_name, f, "application/gzip")}
             data = await self._request("POST", f"/artifacts/upload/{listing_id}", files=files)
         return UploadArtifactResponse(**data)
 

kscale/store/pybullet.py

@@ -27,7 +27,10 @@ async def main(args: Sequence[str] | None = None) -> None:
     parsed_args = parser.parse_args(args)
 
     # Gets the URDF path.
-    urdf_path = await download_urdf(parsed_args.listing_id)
+    urdf_dir = await download_urdf(parsed_args.listing_id)
+    urdf_path = next(urdf_dir.glob("*.urdf"), None)
+    if urdf_path is None:
+        raise ValueError(f"No URDF found in {urdf_dir}")
 
     try:
         import pybullet as p  # type: ignore[import-not-found]

kscale/store/urdf.py

@@ -14,13 +14,24 @@ import requests
 
 from kscale.conf import Settings
 from kscale.store.client import KScaleStoreClient
-from kscale.store.gen.api import SingleArtifactResponse
+from kscale.store.gen.api import SingleArtifactResponse, UploadArtifactResponse
 from kscale.store.utils import get_api_key
 
 # Set up logging
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
+ALLOWED_SUFFIXES = {
+    ".urdf",
+    ".mjcf",
+    ".stl",
+    ".obj",
+    ".dae",
+    ".png",
+    ".jpg",
+    ".jpeg",
+}
+
 
 def get_cache_dir() -> Path:
     return Path(Settings.load().store.cache_dir).expanduser().resolve()
@@ -75,7 +86,7 @@ def create_tarball(folder_path: Path, output_filename: str, cache_dir: Path) ->
     tarball_path = cache_dir / output_filename
     with tarfile.open(tarball_path, "w:gz") as tar:
         for file_path in folder_path.rglob("*"):
-            if file_path.is_file() and file_path.suffix.lower() in (".urdf", ".mjcf", ".stl", ".obj", ".dae"):
+            if file_path.is_file() and file_path.suffix.lower() in ALLOWED_SUFFIXES:
                 tar.add(file_path, arcname=file_path.relative_to(folder_path))
                 logger.info("Added %s to tarball", file_path)
             else:
@@ -128,18 +139,24 @@ async def remove_local_urdf(artifact_id: str) -> None:
         raise
 
 
-async def upload_urdf(listing_id: str, args: Sequence[str]) -> None:
-    parser = argparse.ArgumentParser(description="K-Scale URDF Store", add_help=False)
-    parser.add_argument("root_dir", type=Path, help="The path to the root directory to upload")
-    parsed_args = parser.parse_args(args)
-
-    root_dir = parsed_args.root_dir
+async def upload_urdf(listing_id: str, root_dir: Path) -> UploadArtifactResponse:
     tarball_path = create_tarball(root_dir, "robot.tgz", get_artifact_dir(listing_id))
 
     async with KScaleStoreClient() as client:
         response = await client.upload_artifact(listing_id, str(tarball_path))
 
     logger.info("Uploaded artifacts: %s", [artifact.artifact_id for artifact in response.artifacts])
+    return response
+
+
+async def upload_urdf_cli(listing_id: str, args: Sequence[str]) -> UploadArtifactResponse:
+    parser = argparse.ArgumentParser(description="K-Scale URDF Store", add_help=False)
+    parser.add_argument("root_dir", type=Path, help="The path to the root directory to upload")
+    parsed_args = parser.parse_args(args)
+
+    root_dir = parsed_args.root_dir
+    response = await upload_urdf(listing_id, root_dir)
+    return response
 
 
 Command = Literal["download", "info", "upload", "remove-local"]
@@ -165,7 +182,7 @@ async def main(args: Sequence[str] | None = None) -> None:
             await remove_local_urdf(id)
 
         case "upload":
-            await upload_urdf(id, remaining_args)
+            await upload_urdf_cli(id, remaining_args)
 
         case _:
             logger.error("Invalid command")

kscale/store/utils.py

@@ -4,10 +4,24 @@ import os
 
 from kscale.conf import Settings
 
-API_ROOT = "https://api.kscale.store"
+
+def get_api_root() -> str:
+    """Returns the base URL for the K-Scale Store API.
+
+    This can be overridden when targetting a different server.
+
+    Returns:
+        The base URL for the K-Scale Store API.
+    """
+    return os.getenv("KSCALE_API_ROOT", "https://api.kscale.store")
 
 
 def get_api_key() -> str:
+    """Returns the API key for the K-Scale Store API.
+
+    Returns:
+        The API key for the K-Scale Store API.
+    """
     api_key = Settings.load().store.api_key
     if api_key is None:
         api_key = os.getenv("KSCALE_API_KEY")

{kscale-0.0.5.dist-info → kscale-0.0.7.dist-info}/METADATA

@@ -1,16 +1,17 @@
 Metadata-Version: 2.1
 Name: kscale
-Version: 0.0.5
+Version: 0.0.7
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: omegaconf ==2.3.0
-Requires-Dist: email-validator ==2.2.0
-Requires-Dist: httpx ==0.27.0
-Requires-Dist: requests ==2.32.2
+Requires-Dist: omegaconf
+Requires-Dist: email-validator
+Requires-Dist: httpx
+Requires-Dist: requests
+Requires-Dist: pydantic
 Provides-Extra: dev
 Requires-Dist: black ; extra == 'dev'
 Requires-Dist: darglint ; extra == 'dev'

kscale-0.0.7.dist-info/RECORD

@@ -0,0 +1,21 @@
+kscale/__init__.py,sha256=3DfIJ5zf1Jokj7wyBCtRldKZFvBMVODE8CoieJr1Zo4,117
+kscale/api.py,sha256=xBtKj8rgZ400r1Xx9LRY0AzSgIIttoXdejmhHhdVGS0,333
+kscale/conf.py,sha256=9fShFaYTbnrm_eiGjmy8ZtC4Q4m6PQkWPyoF3eNyov8,1424
+kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kscale/store/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kscale/store/api.py,sha256=rydanYGg8zlc_cNuWo9YBG_WVtPKMxFgp6fpec-B8M0,671
+kscale/store/cli.py,sha256=8ygg_1tZzOOHJotEIgSN9pfumcriPmA31sI_FCFQiTo,859
+kscale/store/client.py,sha256=R1IDnf2J4ojAcP8nmUUHfXhcHUt4zP0-mxtVI7MIC5U,2664
+kscale/store/pybullet.py,sha256=WzA1FVAc19JMY9nUar0go9kcy9BvU8W1lnT9eT1W1LI,7638
+kscale/store/urdf.py,sha256=5x8tK2BYv901S_yYWYPWEnHv-3T0ALBQMdDwb70EZFw,6395
+kscale/store/utils.py,sha256=rFXGkem2oAttAf3bhWmFEhxrqYnaVvlVJsC268IMw6Y,906
+kscale/store/gen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kscale/store/gen/api.py,sha256=82D41J6pg9KWdgD0lx7NggLcNS32SpnN8DqE3Md6ON0,9559
+kscale/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kscale/utils/api_base.py,sha256=Kk_WtRDdJHmOg6NtHmVxVrcfARSUkhfr29ypLch_pO0,112
+kscale-0.0.7.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
+kscale-0.0.7.dist-info/METADATA,sha256=JzwigJrhRpaJNCYKDzgam_allQTuY6G10nR4TU31an0,2504
+kscale-0.0.7.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+kscale-0.0.7.dist-info/entry_points.txt,sha256=PaVs1ivqB0BBdGUsiFkxGUYjGLz05VqagxwRVwi4yV4,54
+kscale-0.0.7.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
+kscale-0.0.7.dist-info/RECORD,,

{kscale-0.0.5.dist-info → kscale-0.0.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.1)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

kscale-0.0.5.dist-info/RECORD

@@ -1,21 +0,0 @@
-kscale/__init__.py,sha256=e1NdSlxsBKi5qyOIjXC3vAPQXleZwh2hyVlLHcKQsq8,117
-kscale/api.py,sha256=xBtKj8rgZ400r1Xx9LRY0AzSgIIttoXdejmhHhdVGS0,333
-kscale/conf.py,sha256=9fShFaYTbnrm_eiGjmy8ZtC4Q4m6PQkWPyoF3eNyov8,1424
-kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/store/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/store/api.py,sha256=L-QZMDeOsNo8ovIRjwfBlidYKD510hdoKrmrue7C5Wk,454
-kscale/store/cli.py,sha256=8ygg_1tZzOOHJotEIgSN9pfumcriPmA31sI_FCFQiTo,859
-kscale/store/client.py,sha256=HEyTzgCOXdLCQKdFKwNglvTBtXVipul7cxbdjz53Pb4,2544
-kscale/store/pybullet.py,sha256=viTQCE2jT72miPKZpFKj4f4zGLLYtjhRFxGqzxd2Z8M,7504
-kscale/store/urdf.py,sha256=zMUfJNNpZkoLf-SnhMO28f8Qj39hmZrA0vqLL3sZSqE,6069
-kscale/store/utils.py,sha256=vQSFd9fByDUUSD0dAA65T_WI5R55vY-HOQjIJg_u2jw,536
-kscale/store/gen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/store/gen/api.py,sha256=82D41J6pg9KWdgD0lx7NggLcNS32SpnN8DqE3Md6ON0,9559
-kscale/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/utils/api_base.py,sha256=Kk_WtRDdJHmOg6NtHmVxVrcfARSUkhfr29ypLch_pO0,112
-kscale-0.0.5.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
-kscale-0.0.5.dist-info/METADATA,sha256=jAkpxXCrUa8b30BY32OaW6eIoR0VFHQzKgzO26EDFGM,2514
-kscale-0.0.5.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
-kscale-0.0.5.dist-info/entry_points.txt,sha256=PaVs1ivqB0BBdGUsiFkxGUYjGLz05VqagxwRVwi4yV4,54
-kscale-0.0.5.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
-kscale-0.0.5.dist-info/RECORD,,