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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: kscale
-Version: 0.0.11
+Version: 0.1.0
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte
@@ -8,23 +8,35 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: omegaconf
-Requires-Dist: email-validator
+Requires-Dist: email_validator
+Requires-Dist: colorlogging
+Requires-Dist: aiohttp
+Requires-Dist: cryptography
 Requires-Dist: httpx
-Requires-Dist: requests
 Requires-Dist: pydantic
+Requires-Dist: pyjwt
+Requires-Dist: requests
+Requires-Dist: yarl
+Requires-Dist: aiofiles
+Requires-Dist: click
+Requires-Dist: tabulate
+Requires-Dist: async-lru
+Requires-Dist: krec
 Provides-Extra: dev
-Requires-Dist: black ; extra == 'dev'
-Requires-Dist: darglint ; extra == 'dev'
-Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: ruff ; extra == 'dev'
-Requires-Dist: datamodel-code-generator ; extra == 'dev'
-
-<p align="center">
-  <picture>
-    <img alt="K-Scale Open Source Robotics" src="https://media.kscale.dev/kscale-open-source-header.png" style="max-width: 100%;">
-  </picture>
-</p>
+Requires-Dist: black; extra == "dev"
+Requires-Dist: darglint; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: datamodel-code-generator; extra == "dev"
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <div align="center">
 
@@ -43,41 +55,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.1.0.dist-info/RECORD

@@ -0,0 +1,36 @@
+kscale/__init__.py,sha256=2jGtLxds4EdX8FEGT3yA74b0VgrkOEBx_PxiWvoh924,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/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kscale/requirements-dev.txt,sha256=WI7-ea4IRJakmqVMN8QKhOsDGrghwtvk03aIsFaNSIw,130
+kscale/requirements.txt,sha256=lKDpyebp9nHZ2uHIuS6FQ6SAg7YO_0sDyb67MFmP4h4,214
+kscale/artifacts/__init__.py,sha256=RK8wdybtCJPgdLLJ8R8-YMi1Ph5ojqAKVJZowHONtgo,232
+kscale/artifacts/plane.obj,sha256=x59-IIrWpLjhotChiqT2Ul6U8s0RcHkaEeUZb4KXL1c,348
+kscale/artifacts/plane.urdf,sha256=LCiTk14AyTHjkZ1jvsb0hNaEaJUxDb8Z1JjsgpXu3YM,819
+kscale/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kscale/utils/api_base.py,sha256=Kk_WtRDdJHmOg6NtHmVxVrcfARSUkhfr29ypLch_pO0,112
+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/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
+kscale/web/cli/token.py,sha256=1rFC8MYKtqbNsQa2KIqwW1tqpaMtFaxuNsallwejXTU,787
+kscale/web/cli/user.py,sha256=qO0z2K5uA48hEiOOYEzv6BO2nOlCpITTDZFuiNl6d34,817
+kscale/web/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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/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.0.11.dist-info → kscale-0.1.0.dist-info}/WHEEL

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

kscale-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ks = kscale.cli:cli
+kscale = kscale.cli:cli

kscale/store/api.py

@@ -1,64 +0,0 @@
-"""Defines a common interface for the K-Scale Store API."""
-
-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
-
-
-class StoreAPI(APIBase):
-    def __init__(
-        self,
-        *,
-        api_key: str | None = None,
-    ) -> None:
-        super().__init__()
-
-        self.api_key = api_key
-
-    async def artifact_root(self, artifact_id: str) -> Path:
-        return await download_urdf(artifact_id)
-
-    @overload
-    async def urdf_path(self, artifact_id: str) -> Path: ...
-
-    @overload
-    async def urdf_path(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None: ...
-
-    async def urdf_path(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None:
-        root_dir = await self.artifact_root(artifact_id)
-        urdf_path = next(root_dir.glob("*.urdf"), None)
-        if urdf_path is None and throw_if_missing:
-            raise FileNotFoundError(f"No URDF found for artifact {artifact_id}")
-        return urdf_path
-
-    @overload
-    async def mjcf_path(self, artifact_id: str) -> Path: ...
-
-    @overload
-    async def mjcf_path(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None: ...
-
-    async def mjcf_path(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None:
-        root_dir = await self.artifact_root(artifact_id)
-        mjcf_path = next(root_dir.glob("*.mjcf"), None)
-        if mjcf_path is None and throw_if_missing:
-            raise FileNotFoundError(f"No MJCF found for artifact {artifact_id}")
-        return mjcf_path
-
-    @overload
-    async def xml_path(self, artifact_id: str) -> Path: ...
-
-    @overload
-    async def xml_path(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None: ...
-
-    async def xml_path(self, artifact_id: str, *, throw_if_missing: bool = True) -> Path | None:
-        root_dir = await self.artifact_root(artifact_id)
-        xml_path = next(root_dir.glob("*.xml"), None)
-        if xml_path is None and throw_if_missing:
-            raise FileNotFoundError(f"No XML found for artifact {artifact_id}")
-        return xml_path
-
-    async def upload_urdf(self, listing_id: str, root_dir: Path) -> UploadArtifactResponse:
-        return await upload_urdf(listing_id, root_dir)

kscale/store/cli.py

@@ -1,35 +0,0 @@
-"""Defines the top-level KOL CLI."""
-
-import argparse
-import asyncio
-from typing import Sequence
-
-from kscale.store import pybullet, urdf
-
-
-async def main(args: Sequence[str] | None = None) -> None:
-    parser = argparse.ArgumentParser(description="K-Scale OnShape Library", add_help=False)
-    parser.add_argument(
-        "subcommand",
-        choices=[
-            "urdf",
-            "pybullet",
-        ],
-        help="The subcommand to run",
-    )
-    parsed_args, remaining_args = parser.parse_known_args(args)
-
-    match parsed_args.subcommand:
-        case "urdf":
-            await urdf.main(remaining_args)
-        case "pybullet":
-            await pybullet.main(remaining_args)
-
-
-def sync_main(args: Sequence[str] | None = None) -> None:
-    asyncio.run(main(args))
-
-
-if __name__ == "__main__":
-    # python3 -m kscale.store.cli
-    sync_main()

kscale/store/client.py

@@ -1,82 +0,0 @@
-"""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()}"},
-            timeout=httpx.Timeout(30.0),
-        )
-
-    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()