arraylake 1.2.0__tar.gz → 1.3.0__tar.gz

{arraylake-1.2.0 → arraylake-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arraylake
-Version: 1.2.0
+Version: 1.3.0
 Summary: Python client for ArrayLake
 Project-URL: Documentation, https://docs.earthmover.io/
 Project-URL: Changelog, https://docs.earthmover.io/changelog
@@ -14,14 +14,14 @@ Requires-Python: <3.15,>=3.12
 Requires-Dist: click<9.0,>=8.1.3
 Requires-Dist: donfig<1.0,>=0.7
 Requires-Dist: httpx<0.29,>=0.23
-Requires-Dist: icechunk<3.0.0,>=2.0.6
+Requires-Dist: icechunk<3.0.0,>=2.1.2
 Requires-Dist: numpy<3.0,>=1.23
 Requires-Dist: packaging<27.0,>=23.0
 Requires-Dist: pydantic[email]<3.0,>=2.9
 Requires-Dist: python-dateutil<3.0,>=2.8
 Requires-Dist: rich<16.0,>=12.6
 Requires-Dist: ruamel-yaml<1.0,>=0.17
-Requires-Dist: structlog<26.0,>=24.1
+Requires-Dist: structlog<27.0,>=24.1
 Requires-Dist: typer<1.0,>=0.12.0
 Requires-Dist: zarr<4.0,>=3.1.0
 Provides-Extra: maximal

{arraylake-1.2.0 → arraylake-1.3.0}/arraylake/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.2.0'
-__version_tuple__ = version_tuple = (1, 2, 0)
+__version__ = version = '1.3.0'
+__version_tuple__ = version_tuple = (1, 3, 0)
 
 __commit_id__ = commit_id = None

{arraylake-1.2.0 → arraylake-1.3.0}/arraylake/api_utils.py

@@ -84,6 +84,25 @@ def _get_proxy_from_env() -> str | None:
     return None
 
 
+# Client name reported in the X-Arraylake-Client header. Defaults to the Python
+# library; the CLI entry point overrides it so server logs can tell them apart.
+_client_name: str = "python"
+
+
+def set_client_name(name: str) -> None:
+    """Override the client name sent in the ``X-Arraylake-Client`` header.
+
+    Must be called before any ``ArraylakeHttpClient`` is constructed to take effect,
+    since headers are baked in at construction time.
+    """
+    global _client_name
+    _client_name = name
+
+
+def get_client_name() -> str:
+    return _client_name
+
+
 @functools.cache
 def _get_session_id() -> str:
     """Session ID for this Python process.
@@ -317,6 +336,9 @@ class ArraylakeHttpClient:
             # technically we don't enforce this, for now it's for debugging purposes
             "client-name": "arraylake-python-client",
             "client-version": arraylake.__version__,
+            "x-arraylake-client": f"{get_client_name()}/{arraylake.__version__}",
+            "x-arraylake-source": get_client_name(),
+            "user-agent": f"arraylake-{get_client_name()}/{arraylake.__version__}",
             "arraylake-session-id": _get_session_id(),
         }
 
@@ -448,6 +470,7 @@ def _exception_log_debug(request: httpx.Request, response: httpx.Response):
 
 
 _emitted_deprecation_warnings: set[str] = set()
+_emitted_user_warnings: set[str] = set()
 
 
 def handle_response(response: httpx.Response):
@@ -456,6 +479,10 @@ def handle_response(response: httpx.Response):
     if deprecation_msg and deprecation_msg not in _emitted_deprecation_warnings:
         _emitted_deprecation_warnings.add(deprecation_msg)
         warnings.warn(deprecation_msg, DeprecationWarning, stacklevel=2)
+    warning_msg = response.headers.get("X-Arraylake-Warning")  # Service-sent user-facing warnings
+    if warning_msg and warning_msg not in _emitted_user_warnings:
+        _emitted_user_warnings.add(warning_msg)
+        warnings.warn(warning_msg, UserWarning, stacklevel=2)
     try:
         response.raise_for_status()
     except httpx.RequestError as exc:

{arraylake-1.2.0 → arraylake-1.3.0}/arraylake/cli/auth.py

@@ -2,7 +2,6 @@ import typer
 from rich.align import Align
 from rich.panel import Panel
 
-from arraylake import config
 from arraylake.cli.utils import (
     coro,
     error_console,
@@ -17,11 +16,26 @@ auth = typer.Typer(help="Manage Arraylake authentication")
 
 NOT_LOGGED_IN_MESSAGE = "⚠️  Not logged in, please log in with: `arraylake auth login`"
 
+SERVICE_URI_OPTION = typer.Option(
+    None,
+    "--service-uri",
+    help=(
+        "Arraylake API endpoint to act on, e.g. **https://api.dev.earthmover.io**. Defaults to the configured "
+        "**service.uri**. Tokens are stored per endpoint, so this need not be persisted to config — unless "
+        "**service.token_path** is set, which makes all endpoints share one token file."
+    ),
+)
+
+
+def _resolve_service_uri(service_uri: str | None) -> str:
+    return service_uri if service_uri else default_service_uri()
+
 
 @auth.command()
 @coro  # type: ignore
 async def login(
     browser: bool = typer.Option(True, "--browser/--no-browser", " /--nobrowser", help="Whether to automatically open a browser window."),
+    service_uri: str | None = SERVICE_URI_OPTION,
 ):
     """**Log in** to Arraylake
 
@@ -34,17 +48,23 @@ async def login(
         ```
         $ arraylake auth login --no-browser
         ```
+
+    - Log in to a non-default Arraylake deployment
+
+        ```
+        $ arraylake auth login --service-uri https://api.dev.earthmover.io
+        ```
     """
     print_logo()
-    handler = get_auth_handler(api_endpoint=default_service_uri())
+    handler = get_auth_handler(api_endpoint=_resolve_service_uri(service_uri))
     await handler.login(browser=browser)
 
 
 @auth.command()
 @coro  # type: ignore
-async def refresh() -> None:
+async def refresh(service_uri: str | None = SERVICE_URI_OPTION) -> None:
     """**Refresh** Arraylake's auth token"""
-    handler = get_auth_handler(api_endpoint=default_service_uri())
+    handler = get_auth_handler(api_endpoint=_resolve_service_uri(service_uri))
     if handler.tokens is not None:
         try:
             await handler.refresh_token()
@@ -57,7 +77,7 @@ async def refresh() -> None:
 
 @auth.command()
 @coro  # type: ignore
-async def logout() -> None:
+async def logout(service_uri: str | None = SERVICE_URI_OPTION) -> None:
     """**Logout** of Arraylake
 
     **Examples**
@@ -67,9 +87,15 @@ async def logout() -> None:
         ```
         $ arraylake auth logout
         ```
+
+    - Log out of a non-default Arraylake deployment
+
+        ```
+        $ arraylake auth logout --service-uri https://api.dev.earthmover.io
+        ```
     """
     try:
-        handler = get_auth_handler(api_endpoint=default_service_uri())
+        handler = get_auth_handler(api_endpoint=_resolve_service_uri(service_uri))
         await handler.logout()
     except AuthException as e:
         error_console.print(e)
@@ -77,14 +103,15 @@ async def logout() -> None:
 
 
 @auth.command()
-@coro
-async def status():
+@coro  # type: ignore
+async def status(service_uri: str | None = SERVICE_URI_OPTION):
     """Verify and display information about your authentication **status**"""
+    endpoint = _resolve_service_uri(service_uri)
     print_logo_mini()
-    rich_console.print(Align(Panel.fit(f"[bold]Arraylake API Endpoint[/bold]: {config.get('service.uri')}"), align="center"))
+    rich_console.print(Align(Panel.fit(f"[bold]Arraylake API Endpoint[/bold]: {endpoint}"), align="center"))
 
     try:
-        handler = get_auth_handler(api_endpoint=default_service_uri())
+        handler = get_auth_handler(api_endpoint=endpoint)
         user = await handler._get_user()  # checks that the new tokens are valid
         rich_console.print(Align(f"[green][bold]🔓 Logged in as {user.email}[/green][/bold]", align="center"))
     except AuthException:
@@ -93,9 +120,9 @@ async def status():
 
 
 @auth.command()
-def token():
+def token(service_uri: str | None = SERVICE_URI_OPTION):
     """Display your authentication **token**"""
-    handler = get_auth_handler(api_endpoint=default_service_uri())
+    handler = get_auth_handler(api_endpoint=_resolve_service_uri(service_uri))
     if handler.tokens is None:
         rich_console.print(Align(f"[yellow]{NOT_LOGGED_IN_MESSAGE}[/yellow]", align="center"))
         raise typer.Exit(code=1)

{arraylake-1.2.0 → arraylake-1.3.0}/arraylake/cli/compute.py

@@ -48,6 +48,7 @@ def _services_table(services, org):
 def enable_service(
     org: str = typer.Argument(..., help="The organization to enable the service for"),
     protocol: str = typer.Argument(..., help="The protocol to enable. Must be one of: dap2, edr, wms, tiles, zarr"),
+    sku_code: str = typer.Option(..., "--sku-code", "-s", help="The compute shape to run the service on, e.g. xs"),
     is_public: bool = typer.Option(False, help="Whether the service is public"),
     deployment_name: str | None = typer.Option(
         None,
@@ -63,13 +64,13 @@ def enable_service(
     - Enable a new DAP service for _my-org_
 
         ```
-        $ arraylake compute enable my-org dap2
+        $ arraylake compute enable my-org dap2 --sku-code xs
         ```
 
     - Enable a tiles service with a custom deployment name
 
         ```
-        $ arraylake compute enable my-org tiles --deployment-name my-tiles
+        $ arraylake compute enable my-org tiles --sku-code s --deployment-name my-tiles
         ```
     """
     kwargs = {}
@@ -77,7 +78,7 @@ def enable_service(
         kwargs["deployment_name"] = deployment_name
 
     with simple_progress(f"Creating [bold]{protocol}[/bold] service for [bold]{org}[/bold]..."):
-        status = Client().get_services(org).enable(protocol, is_public, **kwargs)
+        status = Client().get_services(org).enable(protocol, is_public, sku_code=sku_code, **kwargs)
     rich_console.print(status["message"])
 
 
@@ -183,6 +184,44 @@ async def get_service_logs(
         raise typer.Exit(code=1)
 
 
+@app.command(name="update")
+def update_service(
+    org: str = typer.Argument(..., help="The organization that the service belongs to"),
+    service_id: str = typer.Argument(..., help="The service ID to update"),
+    sku: str | None = typer.Option(None, "--sku", help="The compute shape (SKU code) to resize the service to"),
+    min_replicas: int | None = typer.Option(None, min=0, help="The minimum number of replicas the service scales down to"),
+    max_replicas: int | None = typer.Option(None, min=1, help="The maximum number of replicas the service scales up to"),
+):
+    """**Update** a running service's shape or scaling. Omitted options keep their current values.
+
+    **Examples**
+
+    - Resize a service with ID edr-1234567 to a different compute shape
+
+        ```
+        $ arraylake compute update my-org edr-1234567 --sku medium
+        ```
+
+    - Change the scaling bounds of a service
+
+        ```
+        $ arraylake compute update my-org edr-1234567 --min-replicas 2 --max-replicas 10
+        ```
+    """
+    if sku is None and min_replicas is None and max_replicas is None:
+        rich_console.print("[bold red]Nothing to update: pass at least one of --sku, --min-replicas, --max-replicas[/bold red]")
+        raise typer.Exit(code=1)
+
+    with simple_progress(f"Updating service [bold]{service_id}[/bold]..."):
+        deployment = Client().get_services(org).update(service_id, sku_code=sku, min_replicas=min_replicas, max_replicas=max_replicas)
+
+    config = deployment.config
+    rich_console.print(
+        f"Service [bold]{deployment.name}[/bold] updated: "
+        f"sku={config.sku_code}, min_replicas={config.min_replicas}, max_replicas={config.max_replicas}"
+    )
+
+
 @app.command(name="disable")
 def disable_service(
     org: str = typer.Argument(..., help="The organization that the service belongs to"),

{arraylake-1.2.0 → arraylake-1.3.0}/arraylake/cli/main.py

@@ -2,9 +2,11 @@ import typer
 
 from arraylake import __version__
 from arraylake import config as config_obj
+from arraylake.api_utils import set_client_name
 from arraylake.cli.auth import auth
 from arraylake.cli.compute import app as compute_app
 from arraylake.cli.config import app as config_app
+from arraylake.cli.org import app as org_app
 from arraylake.cli.repo import app as repo_app
 from arraylake.cli.skills import app as skills_app
 from arraylake.cli.utils import rich_console
@@ -36,12 +38,15 @@ def main(
     ),
 ):
     """Manage ArrayLake from the command line."""
+    # Distinguish CLI usage from library usage in server access logs
+    set_client_name("python-cli")
     if config:
         opts = dict(map(lambda x: x.split("="), config))
         config_obj.set(opts, priority="new")
 
 
 app.add_typer(auth, name="auth")
+app.add_typer(org_app, name="org")
 app.add_typer(repo_app, name="repo")
 app.add_typer(config_app, name="config")
 app.add_typer(compute_app, name="compute")

arraylake-1.3.0/arraylake/cli/org.py

@@ -0,0 +1,41 @@
+import typer
+from rich.table import Table
+
+from arraylake import AsyncClient
+from arraylake.cli.utils import coro, rich_console, simple_progress
+
+app = typer.Typer(help="Manage Arraylake organizations", no_args_is_help=True)
+
+
+def _orgs_table(orgs) -> Table:
+    table = Table(title="Arraylake Organizations", min_width=60)
+    table.add_column("Name", justify="left", style="cyan", no_wrap=True, min_width=30)
+    table.add_column("Display Name", justify="left", style="green", min_width=20)
+    table.add_column("Status", justify="right", style="green", min_width=10)
+
+    for org in orgs:
+        table.add_row(org.name, org.display_name or org.name, org.status)
+
+    return table
+
+
+@app.command(name="list")
+@coro
+async def list_orgs():
+    """**List** all organizations for the authenticated user
+
+    **Examples**
+
+    - List all orgs
+
+        ```
+        $ arraylake org list
+        ```
+    """
+    with simple_progress("Listing orgs..."):
+        orgs = await AsyncClient().get_orgs()
+
+    if orgs:
+        rich_console.print(_orgs_table(orgs))
+    else:
+        rich_console.print("\nNo organizations found")