kscale 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

kscale/__init__.py

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

kscale/conf.py

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

kscale/web/api.py

@@ -12,3 +12,7 @@ class WebAPI(APIBase):
     async def get_profile_info(self) -> ProfileResponse:
         client = await self.www_client()
         return await client.get_profile_info()
+
+    async def get_api_key(self, num_hours: int = 24) -> str:
+        client = await self.www_client()
+        return await client.get_api_key(num_hours)

kscale/web/cli/user.py

@@ -3,6 +3,7 @@
 import logging
 
 import click
+from tabulate import tabulate
 
 from kscale.utils.cli import coro
 from kscale.web.clients.user import UserClient
@@ -19,14 +20,33 @@ def cli() -> None:
 @cli.command()
 @coro
 async def me() -> None:
+    """Get information about the currently-authenticated user."""
     client = UserClient()
     profile = await client.get_profile_info()
-    logger.info("Email: %s", profile.email)
-    logger.info("Email verified: %s", profile.email_verified)
-    logger.info("User ID: %s", profile.user.user_id)
-    logger.info("Is admin: %s", profile.user.is_admin)
-    logger.info("Can upload: %s", profile.user.can_upload)
-    logger.info("Can test: %s", profile.user.can_test)
+    click.echo(
+        tabulate(
+            [
+                ["Email", profile.email],
+                ["Email verified", profile.email_verified],
+                ["User ID", profile.user.user_id],
+                ["Is admin", profile.user.is_admin],
+                ["Can upload", profile.user.can_upload],
+                ["Can test", profile.user.can_test],
+            ],
+            headers=["Key", "Value"],
+            tablefmt="simple",
+        )
+    )
+
+
+@cli.command()
+@coro
+async def key() -> None:
+    """Get an API key for the currently-authenticated user."""
+    client = UserClient()
+    api_key = await client.get_api_key()
+    click.echo("API key:")
+    click.echo(click.style(api_key, fg="green"))
 
 
 if __name__ == "__main__":

kscale/web/clients/base.py

@@ -3,6 +3,7 @@
 import asyncio
 import json
 import logging
+import os
 import secrets
 import time
 import webbrowser
@@ -19,13 +20,16 @@ from pydantic import BaseModel
 from yarl import URL
 
 from kscale.web.gen.api import OICDInfo
-from kscale.web.utils import DEFAULT_UPLOAD_TIMEOUT, get_api_root, get_cache_dir
+from kscale.web.utils import DEFAULT_UPLOAD_TIMEOUT, get_api_root, get_auth_dir
 
 logger = logging.getLogger(__name__)
 
 # This port matches the available port for the OAuth callback.
 OAUTH_PORT = 16821
 
+# This is the name of the API key header for the K-Scale WWW API.
+HEADER_NAME = "x-kscale-api-key"
+
 
 class OAuthCallback:
     def __init__(self) -> None:
@@ -162,7 +166,7 @@ class BaseClient:
 
     @alru_cache
     async def _get_oicd_info(self) -> OICDInfo:
-        cache_path = get_cache_dir() / "oicd_info.json"
+        cache_path = get_auth_dir() / "oicd_info.json"
         if self.use_cache and cache_path.exists():
             with open(cache_path, "r") as f:
                 return OICDInfo(**json.load(f))
@@ -180,7 +184,7 @@ class BaseClient:
         Returns:
             The OpenID Connect server configuration.
         """
-        cache_path = get_cache_dir() / "oicd_metadata.json"
+        cache_path = get_auth_dir() / "oicd_metadata.json"
         if self.use_cache and cache_path.exists():
             with open(cache_path, "r") as f:
                 return json.load(f)
@@ -202,12 +206,24 @@ class BaseClient:
         Returns:
             A bearer token to use with the K-Scale WWW API.
         """
+        # Check if we are in a headless environment.
+        error_message = (
+            "Cannot perform browser-based authentication in a headless environment. "
+            "Please use 'kscale user key' to generate an API key locally and set "
+            "the KSCALE_API_KEY environment variable instead."
+        )
+        try:
+            if not webbrowser.get().name != "null":
+                raise RuntimeError(error_message)
+        except webbrowser.Error:
+            raise RuntimeError(error_message)
+
         oicd_info = await self._get_oicd_info()
         metadata = await self._get_oicd_metadata()
         auth_endpoint = metadata["authorization_endpoint"]
 
         # Use the cached state and nonce if available, otherwise generate.
-        state_file = get_cache_dir() / "oauth_state.json"
+        state_file = get_auth_dir() / "oauth_state.json"
         state: str | None = None
         nonce: str | None = None
         if state_file.exists():
@@ -301,7 +317,7 @@ class BaseClient:
         Returns:
             A bearer token to use with the K-Scale WWW API.
         """
-        cache_path = get_cache_dir() / "bearer_token.txt"
+        cache_path = get_auth_dir() / "bearer_token.txt"
         if self.use_cache and cache_path.exists():
             token = cache_path.read_text()
             if not await self._is_token_expired(token):
@@ -315,9 +331,16 @@ class BaseClient:
     async def get_client(self, *, auth: bool = True) -> httpx.AsyncClient:
         client = self._client if auth else self._client_no_auth
         if client is None:
+            headers: dict[str, str] = {}
+            if auth:
+                if "KSCALE_API_KEY" in os.environ:
+                    headers[HEADER_NAME] = os.environ["KSCALE_API_KEY"]
+                else:
+                    headers["Authorization"] = f"Bearer {await self.get_bearer_token()}"
+
             client = httpx.AsyncClient(
                 base_url=self.base_url,
-                headers={"Authorization": f"Bearer {await self.get_bearer_token()}"} if auth else None,
+                headers=headers,
                 timeout=httpx.Timeout(30.0),
             )
             if auth:

kscale/web/clients/robot_class.py

@@ -3,6 +3,7 @@
 import hashlib
 import json
 import logging
+import tarfile
 from pathlib import Path
 
 import httpx
@@ -13,7 +14,7 @@ from kscale.web.gen.api import (
     RobotDownloadURDFResponse,
     RobotUploadURDFResponse,
 )
-from kscale.web.utils import get_cache_dir, should_refresh_file
+from kscale.web.utils import get_robots_dir, should_refresh_file
 
 logger = logging.getLogger(__name__)
 
@@ -98,7 +99,7 @@ class RobotClassClient(BaseClient):
         return response
 
     async def download_robot_class_urdf(self, class_name: str, *, cache: bool = True) -> Path:
-        cache_path = get_cache_dir() / class_name / "robot.tgz"
+        cache_path = get_robots_dir() / class_name / "robot.tgz"
         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)
@@ -132,7 +133,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("Unpacking downloaded file")
+        with tarfile.open(cache_path, "r:gz") as tar:
+            tar.extractall(path=cache_path.parent)
+
         logger.info("Updating downloaded file information")
         info = {"md5_hash": hash_value_hex}
         with open(cache_path_info, "w") as f:

kscale/web/clients/user.py

@@ -8,3 +8,7 @@ class UserClient(BaseClient):
     async def get_profile_info(self) -> ProfileResponse:
         data = await self._request("GET", "/auth/profile", auth=True)
         return ProfileResponse(**data)
+
+    async def get_api_key(self, num_hours: int = 24) -> str:
+        data = await self._request("POST", "/auth/key", auth=True, data={"num_hours": num_hours})
+        return data["api_key"]

kscale/web/utils.py

@@ -13,9 +13,19 @@ DEFAULT_UPLOAD_TIMEOUT = 300.0  # 5 minutes
 
 
 @functools.lru_cache
-def get_cache_dir() -> Path:
+def get_kscale_dir() -> Path:
     """Returns the cache directory for artifacts."""
-    return Path(Settings.load().www.cache_dir).expanduser().resolve()
+    return Path(Settings.load().www.base_dir).expanduser().resolve()
+
+
+def get_auth_dir() -> Path:
+    """Returns the directory for authentication artifacts."""
+    return get_kscale_dir() / "auth"
+
+
+def get_robots_dir() -> Path:
+    """Returns the directory for robot artifacts."""
+    return get_kscale_dir() / "robots"
 
 
 def should_refresh_file(file: Path) -> bool:
@@ -23,14 +33,6 @@ def should_refresh_file(file: Path) -> bool:
     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."""
-    cache_dir = get_cache_dir() / artifact_id
-    cache_dir.mkdir(parents=True, exist_ok=True)
-    return cache_dir
-
-
 @functools.lru_cache
 def get_api_root() -> str:
     """Returns the root URL for the K-Scale WWW API."""

{kscale-0.1.3.dist-info → kscale-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kscale
-Version: 0.1.3
+Version: 0.1.5
 Summary: The kscale project
 Home-page: https://github.com/kscalelabs/kscale
 Author: Benjamin Bolte

{kscale-0.1.3.dist-info → kscale-0.1.5.dist-info}/RECORD

@@ -1,7 +1,7 @@
-kscale/__init__.py,sha256=jCPBaF41wGta1VKhadMOzjzqpwaKVoU5lWY21BAvCZY,172
+kscale/__init__.py,sha256=SnUAXz1ZDSR98-rg2Ne7pAF7YPDh5i3v3EyoZxR3l-4,172
 kscale/api.py,sha256=jmiuFurTN_Gj_-k-6asqxw8wp-_bgJUXgMPFgJ4lqHA,230
 kscale/cli.py,sha256=PMHLKR5UwdbbReVmqHXpJ-K9-mGHv_0I7KQkwxmFcUA,881
-kscale/conf.py,sha256=x9jJ8pmSweUsLScN741B21SySCrnRZioV-1ZkhmERbI,1585
+kscale/conf.py,sha256=OLGz2J-9NAaICoWeN9-hCxrOsyf0vpJBNw-UzIsHdwE,1572
 kscale/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/requirements-dev.txt,sha256=WI7-ea4IRJakmqVMN8QKhOsDGrghwtvk03aIsFaNSIw,130
 kscale/requirements.txt,sha256=_BGbnKTQaXKx0bNEG0wguod9swsiCb2mF6rLm7sFJ2Q,214
@@ -13,24 +13,24 @@ 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=l_m8GETCThhnXbHfXq53j1b-E__uZ5GuUbsQ8HR0WA0,1037
+kscale/web/api.py,sha256=oyW0XLfX96RPe1xNgdf8ejfATdLlNlP0CL1lP0FN1nM,593
+kscale/web/utils.py,sha256=Mme-FAQ0_zbjjOQeX8wyq8F4kL4i9fH7ytri16U6qOA,1046
 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/cli/user.py,sha256=aaJJCL1P5lfhK6ZC9OwOHXKA-I3MWqVZ_k7TYnx33CY,1303
 kscale/web/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kscale/web/clients/base.py,sha256=voOgOGlrYy-fyFJiLVNVwL4osOo53-ARBsqdhBp4BWA,14263
+kscale/web/clients/base.py,sha256=uovIxtkotRxrIFL0PhLYDIhhfXrIGjXxNY2FLVO3L18,15110
 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=yP-GBToyTyNc9eZzsoVmQuNC98aQHmgScxwsxRiM2v8,5067
-kscale/web/clients/user.py,sha256=9iv8J-ROm_yBIwi-0oqldReLkNBFktdHRv3UCOxBzjY,377
+kscale/web/clients/robot_class.py,sha256=O_6lAKAcdNGFVtojuiQlgPCVP5MQlYPZG5Z-awwauho,5206
+kscale/web/clients/user.py,sha256=jsa1_s6qXRM-AGBbHlPhd1NierUtynjY9tVAPNr6_Os,568
 kscale/web/gen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kscale/web/gen/api.py,sha256=SovcII36JFgK9jd2CXlLPMjiUROGB4vEnapOsYMUrkU,2188
-kscale-0.1.3.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
-kscale-0.1.3.dist-info/METADATA,sha256=Aw4Q4bvhclIV1tG_1a8Gk-ZylIPe84vUUtIkQLXBa68,2340
-kscale-0.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kscale-0.1.3.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
-kscale-0.1.3.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
-kscale-0.1.3.dist-info/RECORD,,
+kscale-0.1.5.dist-info/LICENSE,sha256=HCN2bImAzUOXldAZZI7JZ9PYq6OwMlDAP_PpX1HnuN0,1071
+kscale-0.1.5.dist-info/METADATA,sha256=kTsVXOA7Zh2m_eqBm2iaxanfL92BNpPadsC-vasZ018,2340
+kscale-0.1.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kscale-0.1.5.dist-info/entry_points.txt,sha256=N_0pCpPnwGDYVzOeuaSOrbJkS5L3lS9d8CxpJF1f8UI,62
+kscale-0.1.5.dist-info/top_level.txt,sha256=C2ynjYwopg6YjgttnI2dJjasyq3EKNmYp-IfQg9Xms4,7
+kscale-0.1.5.dist-info/RECORD,,