kscale 0.0.11__tar.gz → 0.0.13__tar.gz

{kscale-0.0.11/kscale.egg-info → kscale-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kscale
-Version: 0.0.11
+Version: 0.0.13
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte
@@ -12,6 +12,9 @@ Requires-Dist: email_validator
 Requires-Dist: httpx
 Requires-Dist: requests
 Requires-Dist: pydantic
+Requires-Dist: click
+Requires-Dist: aiofiles
+Requires-Dist: krec
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: darglint; extra == "dev"
@@ -43,41 +46,10 @@ Requires-Dist: datamodel-code-generator; extra == "dev"
 
 # K-Scale Command Line Interface
 
-This is a command line tool for interacting with various services provided by K-Scale Labs, such as:
-
-- [K-Scale Store](https://kscale.store/)
+This is a command line tool for interacting with various services provided by K-Scale Labs. For more information, see the [documentation](https://docs.kscale.dev/pkg/intro).
 
 ## Installation
 
 ```bash
 pip install kscale
 ```
-
-## Usage
-
-### CLI
-
-Download a URDF from the K-Scale Store:
-
-```bash
-kscale urdf download <artifact_id>
-```
-
-Upload a URDF to the K-Scale Store:
-
-```bash
-kscale urdf upload <artifact_id> <root_dir>
-```
-
-### Python API
-
-Reference a URDF by ID from the K-Scale Store:
-
-```python
-from kscale import KScale
-
-async def main():
-  kscale = KScale()
-  urdf_dir_path = await kscale.store.urdf("123456")
-  print(urdf_dir_path)
-```

{kscale-0.0.11 → kscale-0.0.13}/README.md

@@ -21,41 +21,10 @@
 
 # K-Scale Command Line Interface
 
-This is a command line tool for interacting with various services provided by K-Scale Labs, such as:
-
-- [K-Scale Store](https://kscale.store/)
+This is a command line tool for interacting with various services provided by K-Scale Labs. For more information, see the [documentation](https://docs.kscale.dev/pkg/intro).
 
 ## Installation
 
 ```bash
 pip install kscale
 ```
-
-## Usage
-
-### CLI
-
-Download a URDF from the K-Scale Store:
-
-```bash
-kscale urdf download <artifact_id>
-```
-
-Upload a URDF to the K-Scale Store:
-
-```bash
-kscale urdf upload <artifact_id> <root_dir>
-```
-
-### Python API
-
-Reference a URDF by ID from the K-Scale Store:
-
-```python
-from kscale import KScale
-
-async def main():
-  kscale = KScale()
-  urdf_dir_path = await kscale.store.urdf("123456")
-  print(urdf_dir_path)
-```

{kscale-0.0.11 → kscale-0.0.13}/kscale/__init__.py

@@ -1,9 +1,9 @@
 """Defines the common interface for the K-Scale Python API."""
 
-__version__ = "0.0.11"
+__version__ = "0.0.13"
 
 from pathlib import Path
 
-from kscale.api import KScale
+from kscale.api import K
 
 ROOT_DIR = Path(__file__).parent

{kscale-0.0.11 → kscale-0.0.13}/kscale/api.py

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

kscale-0.0.13/kscale/cli.py

@@ -0,0 +1,25 @@
+"""Defines the top-level KOL CLI."""
+
+import click
+
+from kscale.utils.cli import recursive_help
+from kscale.web.kernels import cli as kernel_images_cli
+from kscale.web.krec import cli as krec_cli
+from kscale.web.pybullet import cli as pybullet_cli
+from kscale.web.urdf import cli as urdf_cli
+
+
+@click.group()
+def cli() -> None:
+    """Command line interface for interacting with the K-Scale web API."""
+    pass
+
+
+cli.add_command(urdf_cli, "urdf")
+cli.add_command(pybullet_cli, "pybullet")
+cli.add_command(kernel_images_cli, "kernel")
+cli.add_command(krec_cli, "krec")
+
+if __name__ == "__main__":
+    # python -m kscale.cli
+    print(recursive_help(cli))

{kscale-0.0.11 → kscale-0.0.13}/kscale/conf.py

@@ -16,14 +16,14 @@ def get_path() -> Path:
 
 
 @dataclass
-class StoreSettings:
+class WWWSettings:
     api_key: str | None = field(default=None)
     cache_dir: str = field(default=II("oc.env:KSCALE_CACHE_DIR,'~/.kscale/cache/'"))
 
 
 @dataclass
 class Settings:
-    store: StoreSettings = field(default_factory=StoreSettings)
+    www: WWWSettings = field(default_factory=WWWSettings)
 
     def save(self) -> None:
         (dir_path := get_path()).mkdir(parents=True, exist_ok=True)

{kscale-0.0.11 → kscale-0.0.13}/kscale/requirements.txt

@@ -8,3 +8,10 @@ email_validator
 httpx
 requests
 pydantic
+
+# CLI
+click
+aiofiles
+
+# K-Scale
+krec

kscale-0.0.13/kscale/utils/checksum.py

@@ -0,0 +1,41 @@
+"""Utility functions for file checksums."""
+
+import hashlib
+from pathlib import Path
+from typing import Tuple
+
+CHUNK_SIZE = 8192
+
+
+async def calculate_sha256(file_path: str | Path) -> Tuple[str, int]:
+    """Calculate SHA256 checksum and size of a file.
+
+    Args:
+        file_path: Path to the file
+
+    Returns:
+        Tuple of (checksum hex string, file size in bytes)
+    """
+    sha256_hash = hashlib.sha256()
+    file_size = 0
+
+    with open(file_path, "rb") as f:
+        for chunk in iter(lambda: f.read(CHUNK_SIZE), b""):
+            sha256_hash.update(chunk)
+            file_size += len(chunk)
+
+    return sha256_hash.hexdigest(), file_size
+
+
+class FileChecksum:
+    """Helper class for handling file checksums."""
+
+    @staticmethod
+    async def calculate(file_path: str | Path) -> Tuple[str, int]:
+        """Calculate SHA256 checksum and size of a file."""
+        return await calculate_sha256(file_path)
+
+    @staticmethod
+    def update_hash(hash_obj: "hashlib._Hash", chunk: bytes) -> None:
+        """Update a hash object with new data."""
+        hash_obj.update(chunk)

kscale-0.0.13/kscale/utils/cli.py

@@ -0,0 +1,28 @@
+"""Defines utilities for working with asyncio."""
+
+import asyncio
+import textwrap
+from functools import wraps
+from typing import Any, Callable, Coroutine, ParamSpec, TypeVar
+
+import click
+
+T = TypeVar("T")
+P = ParamSpec("P")
+
+
+def coro(f: Callable[P, Coroutine[Any, Any, T]]) -> Callable[P, T]:
+    @wraps(f)
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
+        return asyncio.run(f(*args, **kwargs))
+
+    return wrapper
+
+
+def recursive_help(cmd: click.Command, parent: click.Context | None = None, indent: int = 0) -> str:
+    ctx = click.core.Context(cmd, info_name=cmd.name, parent=parent)
+    help_text = cmd.get_help(ctx)
+    commands = getattr(cmd, "commands", {})
+    for sub in commands.values():
+        help_text += recursive_help(sub, ctx, indent + 2)
+    return textwrap.indent(help_text, " " * indent)

{kscale-0.0.11/kscale/store → kscale-0.0.13/kscale/web}/api.py

@@ -1,14 +1,15 @@
-"""Defines a common interface for the K-Scale Store API."""
+"""Defines a common interface for the K-Scale WWW API."""
 
+import asyncio
 from pathlib import Path
 from typing import overload
 
-from kscale.store.gen.api import UploadArtifactResponse
-from kscale.store.urdf import download_urdf, upload_urdf
 from kscale.utils.api_base import APIBase
+from kscale.web.gen.api import UploadArtifactResponse
+from kscale.web.urdf import download_urdf, upload_urdf
 
 
-class StoreAPI(APIBase):
+class WebAPI(APIBase):
     def __init__(
         self,
         *,
@@ -34,6 +35,15 @@ class StoreAPI(APIBase):
             raise FileNotFoundError(f"No URDF found for artifact {artifact_id}")
         return urdf_path
 
+    @overload
+    def urdf_path_sync(self, artifact_id: str) -> Path: ...
+
+    @overload
+    def urdf_path_sync(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None: ...
+
+    def urdf_path_sync(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None:
+        return asyncio.run(self.urdf_path(artifact_id, throw_if_missing=throw_if_missing))
+
     @overload
     async def mjcf_path(self, artifact_id: str) -> Path: ...
 
@@ -47,6 +57,15 @@ class StoreAPI(APIBase):
             raise FileNotFoundError(f"No MJCF found for artifact {artifact_id}")
         return mjcf_path
 
+    @overload
+    def mjcf_path_sync(self, artifact_id: str) -> Path: ...
+
+    @overload
+    def mjcf_path_sync(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None: ...
+
+    def mjcf_path_sync(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None:
+        return asyncio.run(self.mjcf_path(artifact_id, throw_if_missing=throw_if_missing))
+
     @overload
     async def xml_path(self, artifact_id: str) -> Path: ...
 
@@ -62,3 +81,18 @@ class StoreAPI(APIBase):
 
     async def upload_urdf(self, listing_id: str, root_dir: Path) -> UploadArtifactResponse:
         return await upload_urdf(listing_id, root_dir)
+
+    def artifact_root_sync(self, artifact_id: str) -> Path:
+        return asyncio.run(self.artifact_root(artifact_id))
+
+    @overload
+    def xml_path_sync(self, artifact_id: str) -> Path: ...
+
+    @overload
+    def xml_path_sync(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None: ...
+
+    def xml_path_sync(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None:
+        return asyncio.run(self.xml_path(artifact_id, throw_if_missing=throw_if_missing))
+
+    def upload_urdf_sync(self, listing_id: str, root_dir: Path) -> UploadArtifactResponse:
+        return asyncio.run(self.upload_urdf(listing_id, root_dir))