kscale 0.3.16__py3-none-any.whl → 0.3.18__py3-none-any.whl

kscale/__init__.py

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

kscale/cli.py

@@ -6,6 +6,9 @@ import click
 import colorlogging
 
 from kscale.utils.cli import recursive_help
+from kscale.web.cli.clip import cli as clip_cli
+from kscale.web.cli.group import cli as group_cli
+from kscale.web.cli.permission import cli as permission_cli
 from kscale.web.cli.robot import cli as robot_cli
 from kscale.web.cli.robot_class import cli as robot_class_cli
 from kscale.web.cli.user import cli as user_cli
@@ -24,6 +27,9 @@ def cli() -> None:
 cli.add_command(user_cli, "user")
 cli.add_command(robot_class_cli, "robots")
 cli.add_command(robot_cli, "robot")
+cli.add_command(clip_cli, "clips")
+cli.add_command(group_cli, "groups")
+cli.add_command(permission_cli, "permissions")
 
 if __name__ == "__main__":
     # python -m kscale.cli

kscale/web/cli/clip.py

@@ -0,0 +1,132 @@
+"""Defines the CLI for managing clips."""
+
+import logging
+
+import click
+from tabulate import tabulate
+
+from kscale.utils.cli import coro
+from kscale.web.clients.clip import ClipClient
+
+logger = logging.getLogger(__name__)
+
+
+@click.group()
+def cli() -> None:
+    """Manage clips."""
+    pass
+
+
+@cli.command()
+@coro
+async def list() -> None:
+    """Lists all clips for the authenticated user."""
+    client = ClipClient()
+    clips = await client.get_clips()
+    if clips:
+        # Prepare table data
+        table_data = [
+            [
+                click.style(clip.id, fg="blue"),
+                clip.description or "N/A",
+                clip.created_at.strftime("%Y-%m-%d %H:%M:%S"),
+                "N/A" if clip.num_downloads is None else f"{clip.num_downloads:,}",
+                "N/A" if clip.file_size is None else f"{clip.file_size:,} bytes",
+            ]
+            for clip in clips
+        ]
+        click.echo(
+            tabulate(
+                table_data,
+                headers=["ID", "Description", "Created", "Downloads", "Size"],
+                tablefmt="simple",
+            )
+        )
+    else:
+        click.echo(click.style("No clips found", fg="red"))
+
+
+@cli.command()
+@click.argument("clip_id")
+@coro
+async def get(clip_id: str) -> None:
+    """Get information about a specific clip."""
+    client = ClipClient()
+    clip = await client.get_clip(clip_id)
+    click.echo(f"ID: {click.style(clip.id, fg='blue')}")
+    click.echo(f"Description: {click.style(clip.description or 'N/A', fg='green')}")
+    click.echo(f"User ID: {click.style(clip.user_id, fg='yellow')}")
+    click.echo(f"Created: {clip.created_at.strftime('%Y-%m-%d %H:%M:%S')}")
+    click.echo(f"Downloads: {clip.num_downloads or 0}")
+    if clip.file_size:
+        click.echo(f"File Size: {clip.file_size:,} bytes")
+
+
+@cli.command()
+@click.option("-d", "--description", type=str, default=None, help="Description for the clip")
+@coro
+async def create(description: str | None = None) -> None:
+    """Create a new clip."""
+    async with ClipClient() as client:
+        clip = await client.create_clip(description)
+    click.echo("Clip created:")
+    click.echo(f"  ID: {click.style(clip.id, fg='blue')}")
+    click.echo(f"  Description: {click.style(clip.description or 'N/A', fg='green')}")
+    click.echo(f"  Created: {clip.created_at.strftime('%Y-%m-%d %H:%M:%S')}")
+
+
+@cli.command()
+@click.argument("clip_id")
+@click.option("-d", "--description", type=str, default=None, help="New description for the clip")
+@coro
+async def update(clip_id: str, description: str | None = None) -> None:
+    """Update a clip's metadata."""
+    async with ClipClient() as client:
+        clip = await client.update_clip(clip_id, description)
+    click.echo("Clip updated:")
+    click.echo(f"  ID: {click.style(clip.id, fg='blue')}")
+    click.echo(f"  Description: {click.style(clip.description or 'N/A', fg='green')}")
+
+
+@cli.command()
+@click.argument("clip_id")
+@click.confirmation_option(prompt="Are you sure you want to delete this clip?")
+@coro
+async def delete(clip_id: str) -> None:
+    """Delete a clip."""
+    async with ClipClient() as client:
+        await client.delete_clip(clip_id)
+    click.echo(f"Clip deleted: {click.style(clip_id, fg='red')}")
+
+
+@cli.command()
+@click.argument("clip_id")
+@click.argument("file_path", type=click.Path(exists=True))
+@coro
+async def upload(clip_id: str, file_path: str) -> None:
+    """Upload a file for a clip."""
+    async with ClipClient() as client:
+        response = await client.upload_clip(clip_id, file_path)
+    click.echo("File uploaded:")
+    click.echo(f"  Filename: {click.style(response.filename, fg='green')}")
+    click.echo(f"  Content Type: {response.content_type}")
+
+
+@cli.command()
+@click.argument("clip_id")
+@click.option("-o", "--output", type=click.Path(), help="Output file path")
+@coro
+async def download(clip_id: str, output: str | None = None) -> None:
+    """Download a clip file."""
+    async with ClipClient() as client:
+        if output:
+            output_path = await client.download_clip_to_file(clip_id, output)
+            click.echo(f"Clip downloaded to: {click.style(str(output_path), fg='green')}")
+        else:
+            download_response = await client.download_clip(clip_id)
+            click.echo(f"Download URL: {click.style(download_response.url, fg='blue')}")
+            click.echo(f"MD5 Hash: {download_response.md5_hash}")
+
+
+if __name__ == "__main__":
+    cli()

kscale/web/cli/group.py

@@ -0,0 +1,241 @@
+"""Defines the CLI for managing groups."""
+
+import logging
+
+import click
+from tabulate import tabulate
+
+from kscale.utils.cli import coro
+from kscale.web.clients.group import GroupClient
+
+logger = logging.getLogger(__name__)
+
+
+@click.group()
+def cli() -> None:
+    """Manage groups."""
+    pass
+
+
+@cli.command()
+@coro
+async def list() -> None:
+    """Lists all groups for the authenticated user."""
+    client = GroupClient()
+    groups = await client.get_groups()
+    if groups:
+        # Prepare table data
+        table_data = [
+            [
+                click.style(group.id, fg="blue"),
+                click.style(group.name, fg="green"),
+                group.description or "N/A",
+                group.created_at,
+                "Active" if group.is_active else "Inactive",
+            ]
+            for group in groups
+        ]
+        click.echo(
+            tabulate(
+                table_data,
+                headers=["ID", "Name", "Description", "Created", "Status"],
+                tablefmt="simple",
+            )
+        )
+    else:
+        click.echo(click.style("No groups found", fg="red"))
+
+
+@cli.command()
+@click.argument("group_id")
+@coro
+async def get(group_id: str) -> None:
+    """Get information about a specific group."""
+    client = GroupClient()
+    group = await client.get_group(group_id)
+    click.echo(f"ID: {click.style(group.id, fg='blue')}")
+    click.echo(f"Name: {click.style(group.name, fg='green')}")
+    click.echo(f"Description: {click.style(group.description or 'N/A', fg='yellow')}")
+    click.echo(f"Owner ID: {click.style(group.owner_id, fg='cyan')}")
+    click.echo(f"Created: {group.created_at}")
+    click.echo(f"Updated: {group.updated_at}")
+    click.echo(f"Status: {'Active' if group.is_active else 'Inactive'}")
+
+
+@cli.command()
+@click.argument("name")
+@click.option("-d", "--description", type=str, default=None, help="Description for the group")
+@coro
+async def create(name: str, description: str | None = None) -> None:
+    """Create a new group."""
+    async with GroupClient() as client:
+        group = await client.create_group(name, description)
+    click.echo("Group created:")
+    click.echo(f"  ID: {click.style(group.id, fg='blue')}")
+    click.echo(f"  Name: {click.style(group.name, fg='green')}")
+    click.echo(f"  Description: {click.style(group.description or 'N/A', fg='yellow')}")
+
+
+@cli.command()
+@click.argument("group_id")
+@click.option("-n", "--name", type=str, default=None, help="New name for the group")
+@click.option("-d", "--description", type=str, default=None, help="New description for the group")
+@coro
+async def update(group_id: str, name: str | None = None, description: str | None = None) -> None:
+    """Update a group's metadata."""
+    async with GroupClient() as client:
+        group = await client.update_group(group_id, name, description)
+    click.echo("Group updated:")
+    click.echo(f"  ID: {click.style(group.id, fg='blue')}")
+    click.echo(f"  Name: {click.style(group.name, fg='green')}")
+    click.echo(f"  Description: {click.style(group.description or 'N/A', fg='yellow')}")
+
+
+@cli.command()
+@click.argument("group_id")
+@click.confirmation_option(prompt="Are you sure you want to delete this group?")
+@coro
+async def delete(group_id: str) -> None:
+    """Delete a group."""
+    async with GroupClient() as client:
+        await client.delete_group(group_id)
+    click.echo(f"Group deleted: {click.style(group_id, fg='red')}")
+
+
+@cli.group()
+def membership() -> None:
+    """Manage group memberships."""
+    pass
+
+
+@membership.command("list")
+@click.argument("group_id")
+@coro
+async def list_memberships(group_id: str) -> None:
+    """List all memberships for a group."""
+    client = GroupClient()
+    memberships = await client.get_group_memberships(group_id)
+    if memberships:
+        table_data = [
+            [
+                click.style(membership.id, fg="blue"),
+                click.style(membership.user_id, fg="green"),
+                membership.status,
+                membership.requested_at,
+                membership.approved_at or "N/A",
+                membership.approved_by or "N/A",
+            ]
+            for membership in memberships
+        ]
+        click.echo(
+            tabulate(
+                table_data,
+                headers=["ID", "User ID", "Status", "Requested", "Approved", "Approved By"],
+                tablefmt="simple",
+            )
+        )
+    else:
+        click.echo(click.style("No memberships found", fg="red"))
+
+
+@membership.command("request")
+@click.argument("group_id")
+@coro
+async def request_membership(group_id: str) -> None:
+    """Request to join a group."""
+    async with GroupClient() as client:
+        membership = await client.request_group_membership(group_id)
+    click.echo("Membership request sent:")
+    click.echo(f"  ID: {click.style(membership.id, fg='blue')}")
+    click.echo(f"  Status: {membership.status}")
+
+
+@membership.command("approve")
+@click.argument("group_id")
+@click.argument("user_id")
+@coro
+async def approve_membership(group_id: str, user_id: str) -> None:
+    """Approve a membership request."""
+    async with GroupClient() as client:
+        membership = await client.approve_group_membership(group_id, user_id)
+    click.echo("Membership approved:")
+    click.echo(f"  ID: {click.style(membership.id, fg='blue')}")
+    click.echo(f"  Status: {membership.status}")
+
+
+@membership.command("reject")
+@click.argument("group_id")
+@click.argument("user_id")
+@click.confirmation_option(prompt="Are you sure you want to reject this membership?")
+@coro
+async def reject_membership(group_id: str, user_id: str) -> None:
+    """Reject a membership request."""
+    async with GroupClient() as client:
+        await client.reject_group_membership(group_id, user_id)
+    click.echo(f"Membership rejected for user: {click.style(user_id, fg='red')}")
+
+
+@cli.group()
+def share() -> None:
+    """Manage group resource sharing."""
+    pass
+
+
+@share.command("list")
+@click.argument("group_id")
+@coro
+async def list_shares(group_id: str) -> None:
+    """List all resources shared with a group."""
+    client = GroupClient()
+    shares = await client.get_group_shares(group_id)
+    if shares:
+        table_data = [
+            [
+                click.style(share.id, fg="blue"),
+                share.resource_type,
+                click.style(share.resource_id, fg="green"),
+                click.style(share.shared_by, fg="yellow"),
+                share.shared_at,
+            ]
+            for share in shares
+        ]
+        click.echo(
+            tabulate(
+                table_data,
+                headers=["ID", "Type", "Resource ID", "Shared By", "Shared At"],
+                tablefmt="simple",
+            )
+        )
+    else:
+        click.echo(click.style("No shared resources found", fg="red"))
+
+
+@share.command("add")
+@click.argument("group_id")
+@click.argument("resource_type")
+@click.argument("resource_id")
+@coro
+async def add_share(group_id: str, resource_type: str, resource_id: str) -> None:
+    """Share a resource with a group."""
+    async with GroupClient() as client:
+        share = await client.share_resource_with_group(group_id, resource_type, resource_id)
+    click.echo("Resource shared:")
+    click.echo(f"  ID: {click.style(share.id, fg='blue')}")
+    click.echo(f"  Type: {share.resource_type}")
+    click.echo(f"  Resource ID: {click.style(share.resource_id, fg='green')}")
+
+
+@share.command("remove")
+@click.argument("group_id")
+@click.argument("share_id")
+@click.confirmation_option(prompt="Are you sure you want to remove this share?")
+@coro
+async def remove_share(group_id: str, share_id: str) -> None:
+    """Remove a resource share from a group."""
+    async with GroupClient() as client:
+        await client.unshare_resource_from_group(group_id, share_id)
+    click.echo(f"Share removed: {click.style(share_id, fg='red')}")
+
+
+if __name__ == "__main__":
+    cli()

kscale/web/cli/permission.py

@@ -0,0 +1,110 @@
+"""Defines the CLI for managing permissions."""
+
+import logging
+
+import click
+from tabulate import tabulate
+
+from kscale.utils.cli import coro
+from kscale.web.clients.permission import PermissionClient
+
+logger = logging.getLogger(__name__)
+
+
+@click.group()
+def cli() -> None:
+    """Manage user permissions."""
+    pass
+
+
+@cli.command("list-all")
+@coro
+async def list_all_permissions() -> None:
+    """List all available permissions."""
+    client = PermissionClient()
+    permissions = await client.get_all_permissions()
+    if permissions:
+        table_data = [
+            [
+                click.style(perm.permission, fg="blue"),
+                perm.description,
+            ]
+            for perm in permissions
+        ]
+        click.echo(
+            tabulate(
+                table_data,
+                headers=["Permission", "Description"],
+                tablefmt="simple",
+            )
+        )
+    else:
+        click.echo(click.style("No permissions found", fg="red"))
+
+
+@cli.command()
+@click.option("-u", "--user-id", type=str, default="me", help="User ID (default: me)")
+@coro
+async def list(user_id: str = "me") -> None:
+    """List permissions for a user."""
+    client = PermissionClient()
+    user_perms = await client.get_user_permissions(user_id)
+
+    click.echo(f"User: {click.style(user_perms.display_name, fg='green')} ({user_perms.email})")
+    click.echo(f"User ID: {click.style(user_perms.user_id, fg='blue')}")
+    click.echo(f"Status: {'Active' if user_perms.is_active else 'Inactive'}")
+    click.echo("\nPermissions:")
+
+    if user_perms.permissions:
+        for perm in user_perms.permissions:
+            click.echo(f"  • {click.style(perm, fg='yellow')}")
+    else:
+        click.echo(click.style("  No permissions assigned", fg="red"))
+
+
+@cli.command()
+@click.argument("user_id")
+@click.argument("permissions", nargs=-1, required=True)
+@coro
+async def set(user_id: str, permissions: tuple[str, ...]) -> None:
+    """Set permissions for a user (replaces all existing permissions)."""
+    async with PermissionClient() as client:
+        user_perms = await client.update_user_permissions(user_id, list(permissions))
+
+    click.echo("Permissions updated:")
+    click.echo(f"  User: {click.style(user_perms.display_name, fg='green')}")
+    click.echo(f"  Permissions: {', '.join([click.style(p, fg='yellow') for p in user_perms.permissions])}")
+
+
+@cli.command()
+@click.argument("user_id")
+@click.argument("permission")
+@coro
+async def add(user_id: str, permission: str) -> None:
+    """Add a permission to a user."""
+    async with PermissionClient() as client:
+        user_perms = await client.add_user_permission(user_id, permission)
+
+    click.echo("Permission added:")
+    click.echo(f"  User: {click.style(user_perms.display_name, fg='green')}")
+    click.echo(f"  Added: {click.style(permission, fg='yellow')}")
+    click.echo(f"  All permissions: {', '.join([click.style(p, fg='yellow') for p in user_perms.permissions])}")
+
+
+@cli.command()
+@click.argument("user_id")
+@click.argument("permission")
+@coro
+async def remove(user_id: str, permission: str) -> None:
+    """Remove a permission from a user."""
+    async with PermissionClient() as client:
+        user_perms = await client.remove_user_permission(user_id, permission)
+
+    click.echo("Permission removed:")
+    click.echo(f"  User: {click.style(user_perms.display_name, fg='green')}")
+    click.echo(f"  Removed: {click.style(permission, fg='red')}")
+    click.echo(f"  Remaining permissions: {', '.join([click.style(p, fg='yellow') for p in user_perms.permissions])}")
+
+
+if __name__ == "__main__":
+    cli()

kscale/web/cli/robot_class.py

@@ -192,7 +192,7 @@ async def run_pybullet(
 ) -> None:
     """Shows the URDF file for a robot class in PyBullet."""
     try:
-        import pybullet as p
+        import pybullet as p  # noqa: PLC0415
     except ImportError:
         click.echo(click.style("PyBullet is not installed; install it with `pip install pybullet`", fg="red"))
         return
@@ -453,14 +453,14 @@ async def run_mujoco(class_name: str, scene: str, no_cache: bool) -> None:
     launches the Mujoco viewer using the provided MJCF file.
     """
     try:
-        from mujoco_scenes.errors import TemplateNotFoundError
-        from mujoco_scenes.mjcf import list_scenes, load_mjmodel
+        from mujoco_scenes.errors import TemplateNotFoundError  # noqa: PLC0415
+        from mujoco_scenes.mjcf import list_scenes, load_mjmodel  # noqa: PLC0415
     except ImportError:
         click.echo(click.style("Mujoco Scenes is required; install with `pip install mujoco-scenes`", fg="red"))
         return
 
     try:
-        import mujoco.viewer
+        import mujoco.viewer  # noqa: PLC0415
     except ImportError:
         click.echo(click.style("Mujoco is required; install with `pip install mujoco`", fg="red"))
         return

kscale/web/cli/user.py

@@ -30,8 +30,6 @@ async def me() -> None:
                 ["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",
@@ -39,14 +37,5 @@ async def me() -> None:
     )
 
 
-@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(f"API key: {click.style(api_key, fg='green')}")
-
-
 if __name__ == "__main__":
     cli()