kscale 0.0.3__tar.gz → 0.0.6__tar.gz

{kscale-0.0.3/kscale.egg-info → kscale-0.0.6}/PKG-INFO

@@ -1,15 +1,16 @@
 Metadata-Version: 2.1
 Name: kscale
-Version: 0.0.3
+Version: 0.0.6
 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
-Requires-Dist: httpx
-Requires-Dist: requests
+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
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: darglint; extra == "dev"
@@ -50,3 +51,32 @@ This is a command line tool for interacting with various services provided by K-
 ```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.3 → kscale-0.0.6}/README.md

@@ -30,3 +30,32 @@ This is a command line tool for interacting with various services provided by K-
 ```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.6/kscale/__init__.py

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

kscale-0.0.6/kscale/api.py

@@ -0,0 +1,14 @@
+"""Defines common functionality for the K-Scale API."""
+
+from kscale.store.api import StoreAPI
+from kscale.utils.api_base import APIBase
+
+
+class KScale(
+    StoreAPI,
+    APIBase,
+):
+    """Defines a common interface for the K-Scale API."""
+
+    def __init__(self, api_key: str | None = None) -> None:
+        self.api_key = api_key

{kscale-0.0.3 → kscale-0.0.6}/kscale/conf.py

@@ -17,7 +17,7 @@ def get_path() -> Path:
 
 @dataclass
 class StoreSettings:
-    api_key: str = field(default=II("oc.env:KSCALE_API_KEY,"))
+    api_key: str | None = field(default=None)
     cache_dir: str = field(default=II("oc.env:KSCALE_CACHE_DIR,'~/.kscale/cache/'"))
 
 

kscale-0.0.6/kscale/requirements.txt

@@ -0,0 +1,9 @@
+# requirements.txt
+
+# Configuration
+omegaconf==2.3.0
+email_validator==2.2.0
+
+# HTTP requests
+httpx==0.27.0
+requests==2.32.2

kscale-0.0.6/kscale/store/api.py

@@ -0,0 +1,24 @@
+"""Defines a common interface for the K-Scale Store API."""
+
+from pathlib import Path
+
+from kscale.store.gen.api import UploadArtifactResponse
+from kscale.store.urdf import download_urdf, upload_urdf
+from kscale.utils.api_base import APIBase
+
+
+class StoreAPI(APIBase):
+    def __init__(
+        self,
+        *,
+        api_key: str | None = None,
+    ) -> None:
+        super().__init__()
+
+        self.api_key = api_key
+
+    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-0.0.6/kscale/store/client.py

@@ -0,0 +1,81 @@
+"""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
+
+import httpx
+from pydantic import BaseModel
+
+from kscale.store.gen.api import (
+    NewListingRequest,
+    NewListingResponse,
+    SingleArtifactResponse,
+    UploadArtifactResponse,
+)
+from kscale.store.utils import get_api_key, get_api_root
+
+logger = logging.getLogger(__name__)
+
+
+class KScaleStoreClient:
+    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()}"},
+        )
+
+    async def _request(
+        self,
+        method: str,
+        endpoint: str,
+        *,
+        params: Dict[str, Any] | None = None,
+        data: BaseModel | None = None,
+        files: Dict[str, Any] | None = None,
+    ) -> Dict[str, Any]:
+        url = urljoin(self.base_url, endpoint)
+        kwargs: Dict[str, Any] = {"params": params}
+
+        if data:
+            kwargs["json"] = data.dict(exclude_unset=True)
+        if files:
+            kwargs["files"] = files
+
+        response = await self.client.request(method, url, **kwargs)
+        if response.is_error:
+            logger.error(f"Error response from K-Scale Store: {response.text}")
+        response.raise_for_status()
+        return response.json()
+
+    async def get_artifact_info(self, artifact_id: str) -> SingleArtifactResponse:
+        data = await self._request("GET", f"/artifacts/info/{artifact_id}")
+        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": (file_name, f, "application/gzip")}
+            data = await self._request("POST", f"/artifacts/upload/{listing_id}", files=files)
+        return UploadArtifactResponse(**data)
+
+    async def create_listing(self, request: NewListingRequest) -> NewListingResponse:
+        data = await self._request("POST", "/listings", data=request)
+        return NewListingResponse(**data)
+
+    async def close(self) -> None:
+        await self.client.aclose()
+
+    async def __aenter__(self) -> "KScaleStoreClient":
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: Type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        await self.close()

{kscale-0.0.3 → kscale-0.0.6}/kscale/store/gen/api.py

@@ -2,12 +2,12 @@
 
 # generated by datamodel-codegen:
 #   filename:  openapi.json
-#   timestamp: 2024-08-19T06:07:36+00:00
+#   timestamp: 2024-09-04T04:33:58+00:00
 
 from __future__ import annotations
 
 from enum import Enum
-from typing import List, Optional, Union
+from typing import Dict, List, Optional, Union
 
 from pydantic import BaseModel, EmailStr, Field
 
@@ -21,8 +21,9 @@ class AuthResponse(BaseModel):
     api_key: str = Field(..., title="Api Key")
 
 
-class BodySetUrdfUrdfUploadListingIdPost(BaseModel):
-    file: bytes = Field(..., title="File")
+class BodyPullOnshapeDocumentOnshapePullListingIdGet(BaseModel):
+    suffix_to_joint_effort: Optional[Dict[str, float]] = Field(None, title="Suffix To Joint Effort")
+    suffix_to_joint_velocity: Optional[Dict[str, float]] = Field(None, title="Suffix To Joint Velocity")
 
 
 class BodyUploadArtifactsUploadListingIdPost(BaseModel):
@@ -51,7 +52,13 @@ class GetListingResponse(BaseModel):
     description: Optional[str] = Field(..., title="Description")
     child_ids: List[str] = Field(..., title="Child Ids")
     tags: List[str] = Field(..., title="Tags")
+    onshape_url: Optional[str] = Field(..., title="Onshape Url")
     can_edit: bool = Field(..., title="Can Edit")
+    created_at: int = Field(..., title="Created At")
+    views: int = Field(..., title="Views")
+    score: int = Field(..., title="Score")
+    user_vote: Optional[bool] = Field(..., title="User Vote")
+    creator_id: str = Field(..., title="Creator Id")
 
 
 class GetTokenResponse(BaseModel):
@@ -82,42 +89,6 @@ class KeysResponseItem(BaseModel):
     permissions: Optional[List[Permission]] = Field(..., title="Permissions")
 
 
-class ArtifactType(Enum):
-    image = "image"
-
-
-class ArtifactType1(Enum):
-    urdf = "urdf"
-    mjcf = "mjcf"
-
-
-class ArtifactType2(Enum):
-    stl = "stl"
-    obj = "obj"
-    dae = "dae"
-    ply = "ply"
-
-
-class ArtifactType3(Enum):
-    tgz = "tgz"
-    zip = "zip"
-
-
-class ListArtifactsItem(BaseModel):
-    artifact_id: str = Field(..., title="Artifact Id")
-    listing_id: str = Field(..., title="Listing Id")
-    name: str = Field(..., title="Name")
-    artifact_type: Union[ArtifactType, ArtifactType1, ArtifactType2, ArtifactType3] = Field(..., title="Artifact Type")
-    description: Optional[str] = Field(..., title="Description")
-    timestamp: int = Field(..., title="Timestamp")
-    urls: ArtifactUrls
-    is_new: Optional[bool] = Field(None, title="Is New")
-
-
-class ListArtifactsResponse(BaseModel):
-    artifacts: List[ListArtifactsItem] = Field(..., title="Artifacts")
-
-
 class ListKeysResponse(BaseModel):
     keys: List[KeysResponseItem] = Field(..., title="Keys")
 
@@ -130,9 +101,16 @@ class ListListingsResponse(BaseModel):
 class Listing(BaseModel):
     id: str = Field(..., title="Id")
     user_id: str = Field(..., title="User Id")
+    created_at: int = Field(..., title="Created At")
+    updated_at: int = Field(..., title="Updated At")
     name: str = Field(..., title="Name")
     child_ids: List[str] = Field(..., title="Child Ids")
-    description: Optional[str] = Field(..., title="Description")
+    description: Optional[str] = Field(None, title="Description")
+    onshape_url: Optional[str] = Field(None, title="Onshape Url")
+    views: Optional[int] = Field(0, title="Views")
+    upvotes: Optional[int] = Field(0, title="Upvotes")
+    downvotes: Optional[int] = Field(0, title="Downvotes")
+    score: Optional[int] = Field(0, title="Score")
 
 
 class ListingInfoResponse(BaseModel):
@@ -141,6 +119,11 @@ class ListingInfoResponse(BaseModel):
     description: Optional[str] = Field(..., title="Description")
     child_ids: List[str] = Field(..., title="Child Ids")
     image_url: Optional[str] = Field(..., title="Image Url")
+    onshape_url: Optional[str] = Field(..., title="Onshape Url")
+    created_at: int = Field(..., title="Created At")
+    views: int = Field(..., title="Views")
+    score: int = Field(..., title="Score")
+    user_vote: Optional[bool] = Field(..., title="User Vote")
 
 
 class LoginRequest(BaseModel):
@@ -163,6 +146,10 @@ class MyUserInfoResponse(BaseModel):
     github_id: Optional[str] = Field(..., title="Github Id")
     google_id: Optional[str] = Field(..., title="Google Id")
     permissions: Optional[List[Permission1]] = Field(..., title="Permissions")
+    first_name: Optional[str] = Field(..., title="First Name")
+    last_name: Optional[str] = Field(..., title="Last Name")
+    name: Optional[str] = Field(..., title="Name")
+    bio: Optional[str] = Field(..., title="Bio")
 
 
 class NewKeyRequest(BaseModel):
@@ -200,6 +187,48 @@ class PublicUsersInfoResponse(BaseModel):
     users: List[PublicUserInfoResponseItem] = Field(..., title="Users")
 
 
+class SetRequest(BaseModel):
+    onshape_url: Optional[str] = Field(..., title="Onshape Url")
+
+
+class ArtifactType(Enum):
+    image = "image"
+
+
+class ArtifactType1(Enum):
+    urdf = "urdf"
+    mjcf = "mjcf"
+
+
+class ArtifactType2(Enum):
+    stl = "stl"
+    obj = "obj"
+    dae = "dae"
+    ply = "ply"
+
+
+class ArtifactType3(Enum):
+    tgz = "tgz"
+    zip = "zip"
+
+
+class SingleArtifactResponse(BaseModel):
+    artifact_id: str = Field(..., title="Artifact Id")
+    listing_id: str = Field(..., title="Listing Id")
+    name: str = Field(..., title="Name")
+    artifact_type: Union[ArtifactType, ArtifactType1, ArtifactType2, ArtifactType3] = Field(..., title="Artifact Type")
+    description: Optional[str] = Field(..., title="Description")
+    timestamp: int = Field(..., title="Timestamp")
+    urls: ArtifactUrls
+    is_new: Optional[bool] = Field(None, title="Is New")
+
+
+class SortOption(Enum):
+    newest = "newest"
+    most_viewed = "most_viewed"
+    most_upvoted = "most_upvoted"
+
+
 class UpdateArtifactRequest(BaseModel):
     name: Optional[str] = Field(None, title="Name")
     description: Optional[str] = Field(None, title="Description")
@@ -212,18 +241,19 @@ class UpdateListingRequest(BaseModel):
     tags: Optional[List[str]] = Field(None, title="Tags")
 
 
-class UploadArtifactResponse(BaseModel):
-    artifacts: List[ListArtifactsItem] = Field(..., title="Artifacts")
-
-
-class UrdfInfo(BaseModel):
-    artifact_id: str = Field(..., title="Artifact Id")
-    url: str = Field(..., title="Url")
+class UpdateUserRequest(BaseModel):
+    email: Optional[str] = Field(None, title="Email")
+    password: Optional[str] = Field(None, title="Password")
+    github_id: Optional[str] = Field(None, title="Github Id")
+    google_id: Optional[str] = Field(None, title="Google Id")
+    first_name: Optional[str] = Field(None, title="First Name")
+    last_name: Optional[str] = Field(None, title="Last Name")
+    name: Optional[str] = Field(None, title="Name")
+    bio: Optional[str] = Field(None, title="Bio")
 
 
-class UrdfResponse(BaseModel):
-    urdf: Optional[UrdfInfo]
-    listing_id: str = Field(..., title="Listing Id")
+class UploadArtifactResponse(BaseModel):
+    artifacts: List[SingleArtifactResponse] = Field(..., title="Artifacts")
 
 
 class UserInfoResponseItem(BaseModel):
@@ -235,7 +265,7 @@ class UserPublic(BaseModel):
     id: str = Field(..., title="Id")
     email: str = Field(..., title="Email")
     permissions: Optional[List[Permission1]] = Field(None, title="Permissions")
-    created_at: Optional[int] = Field(None, title="Created At")
+    created_at: int = Field(..., title="Created At")
     updated_at: Optional[int] = Field(None, title="Updated At")
     first_name: Optional[str] = Field(None, title="First Name")
     last_name: Optional[str] = Field(None, title="Last Name")
@@ -265,3 +295,7 @@ class GetBatchListingsResponse(BaseModel):
 
 class HTTPValidationError(BaseModel):
     detail: Optional[List[ValidationError]] = Field(None, title="Detail")
+
+
+class ListArtifactsResponse(BaseModel):
+    artifacts: List[SingleArtifactResponse] = Field(..., title="Artifacts")

{kscale-0.0.3 → kscale-0.0.6}/kscale/store/pybullet.py

@@ -29,8 +29,6 @@ async def main(args: Sequence[str] | None = None) -> None:
     # Gets the URDF path.
     urdf_path = await download_urdf(parsed_args.listing_id)
 
-    breakpoint()
-
     try:
         import pybullet as p  # type: ignore[import-not-found]
     except ImportError:

kscale-0.0.6/kscale/store/urdf.py

@@ -0,0 +1,182 @@
+"""Utility functions for managing artifacts in the K-Scale store."""
+
+import argparse
+import asyncio
+import logging
+import shutil
+import sys
+import tarfile
+from pathlib import Path
+from typing import Literal, Sequence, get_args
+
+import httpx
+import requests
+
+from kscale.conf import Settings
+from kscale.store.client import KScaleStoreClient
+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__)
+
+
+def get_cache_dir() -> Path:
+    return Path(Settings.load().store.cache_dir).expanduser().resolve()
+
+
+def get_artifact_dir(artifact_id: str) -> Path:
+    cache_dir = get_cache_dir() / artifact_id
+    cache_dir.mkdir(parents=True, exist_ok=True)
+    return cache_dir
+
+
+async def fetch_urdf_info(artifact_id: str, cache_dir: Path) -> SingleArtifactResponse:
+    response_path = cache_dir / "response.json"
+    if response_path.exists():
+        return SingleArtifactResponse.model_validate_json(response_path.read_text())
+    async with KScaleStoreClient() as client:
+        response = await client.get_artifact_info(artifact_id)
+    response_path.write_text(response.model_dump_json())
+    return response
+
+
+async def download_artifact(artifact_url: str, cache_dir: Path) -> Path:
+    filename = cache_dir / Path(artifact_url).name
+    headers = {
+        "Authorization": f"Bearer {get_api_key()}",
+    }
+
+    if not filename.exists():
+        logger.info("Downloading artifact from %s", artifact_url)
+
+        async with httpx.AsyncClient() as client:
+            response = await client.get(artifact_url, headers=headers)
+            response.raise_for_status()
+            filename.write_bytes(response.content)
+            logger.info("Artifact downloaded to %s", filename)
+    else:
+        logger.info("Artifact already cached at %s", filename)
+
+    # Extract the .tgz file
+    extract_dir = cache_dir / filename.stem
+    if not extract_dir.exists():
+        logger.info("Extracting %s to %s", filename, extract_dir)
+        with tarfile.open(filename, "r:gz") as tar:
+            tar.extractall(path=extract_dir)
+    else:
+        logger.info("Artifact already extracted at %s", extract_dir)
+
+    return extract_dir
+
+
+def create_tarball(folder_path: Path, output_filename: str, cache_dir: Path) -> 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"):
+                tar.add(file_path, arcname=file_path.relative_to(folder_path))
+                logger.info("Added %s to tarball", file_path)
+            else:
+                logger.warning("Skipping %s", file_path)
+    logger.info("Created tarball %s", tarball_path)
+    return tarball_path
+
+
+async def download_urdf(artifact_id: str) -> Path:
+    cache_dir = get_artifact_dir(artifact_id)
+    try:
+        urdf_info = await fetch_urdf_info(artifact_id, cache_dir)
+        artifact_url = urdf_info.urls.large
+        return await download_artifact(artifact_url, cache_dir)
+
+    except requests.RequestException:
+        logger.exception("Failed to fetch URDF info")
+        raise
+
+
+async def show_urdf_info(artifact_id: str) -> None:
+    try:
+        urdf_info = await fetch_urdf_info(artifact_id, get_artifact_dir(artifact_id))
+        logger.info("URDF Artifact ID: %s", urdf_info.artifact_id)
+        logger.info("URDF URL: %s", urdf_info.urls.large)
+    except requests.RequestException:
+        logger.exception("Failed to fetch URDF info")
+        raise
+
+
+async def remove_local_urdf(artifact_id: str) -> None:
+    try:
+        if artifact_id.lower() == "all":
+            cache_dir = get_cache_dir()
+            if cache_dir.exists():
+                logger.info("Removing all local caches at %s", cache_dir)
+                shutil.rmtree(cache_dir)
+            else:
+                logger.error("No local caches found")
+        else:
+            artifact_dir = get_artifact_dir(artifact_id)
+            if artifact_dir.exists():
+                logger.info("Removing local cache at %s", artifact_dir)
+                shutil.rmtree(artifact_dir)
+            else:
+                logger.error("No local cache found for artifact %s", artifact_id)
+
+    except Exception:
+        logger.error("Failed to remove local cache")
+        raise
+
+
+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"]
+
+
+async def main(args: Sequence[str] | None = None) -> None:
+    parser = argparse.ArgumentParser(description="K-Scale URDF Store", add_help=False)
+    parser.add_argument("command", choices=get_args(Command), help="The command to run")
+    parser.add_argument("id", help="The ID to use (artifact when downloading, listing when uploading)")
+    parsed_args, remaining_args = parser.parse_known_args(args)
+
+    command: Command = parsed_args.command
+    id: str = parsed_args.id
+
+    match command:
+        case "download":
+            await download_urdf(id)
+
+        case "info":
+            await show_urdf_info(id)
+
+        case "remove-local":
+            await remove_local_urdf(id)
+
+        case "upload":
+            await upload_urdf_cli(id, remaining_args)
+
+        case _:
+            logger.error("Invalid command")
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

kscale-0.0.6/kscale/store/utils.py

@@ -0,0 +1,33 @@
+"""Utility functions for interacting with the K-Scale Store API."""
+
+import os
+
+from kscale.conf import Settings
+
+
+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")
+    if not api_key:
+        raise ValueError(
+            "API key not found! Get one here and set it as the `KSCALE_API_KEY` environment variable or in your "
+            "config file: https://kscale.store/keys"
+        )
+    return api_key