globus-cli 3.24.0__tar.gz → 3.25.0__tar.gz

{globus-cli-3.24.0/src/globus_cli.egg-info → globus-cli-3.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: globus-cli
-Version: 3.24.0
+Version: 3.25.0
 Summary: Globus CLI
 Author-email: Stephen Rosen <sirosen@globus.org>
 Project-URL: homepage, https://github.com/globus/globus-cli
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: globus-sdk==3.34.0
+Requires-Dist: globus-sdk==3.37.0
 Requires-Dist: click<9,>=8.1.4
 Requires-Dist: jmespath==1.0.1
 Requires-Dist: packaging>=17.0
@@ -31,8 +31,8 @@ Requires-Dist: pytest>=7; extra == "test"
 Requires-Dist: pytest-xdist<4; extra == "test"
 Requires-Dist: pytest-timeout<3; extra == "test"
 Requires-Dist: click-type-test==0.0.7; python_version >= "3.10" and extra == "test"
-Requires-Dist: responses==0.24.1; extra == "test"
-Requires-Dist: ruamel.yaml==0.18.5; extra == "test"
+Requires-Dist: responses==0.25.0; extra == "test"
+Requires-Dist: ruamel.yaml==0.18.6; extra == "test"
 Requires-Dist: setuptools; python_version >= "3.12" and extra == "test"
 
 .. image:: https://github.com/globus/globus-cli/workflows/build/badge.svg?event=push

{globus-cli-3.24.0 → globus-cli-3.25.0}/pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "globus-sdk==3.34.0",
+    "globus-sdk==3.37.0",
     "click>=8.1.4,<9",
     "jmespath==1.0.1",
     "packaging>=17.0",
@@ -50,9 +50,9 @@ test = [
     "pytest-xdist<4",
     "pytest-timeout<3",
     "click-type-test==0.0.7;python_version>='3.10'",
-    "responses==0.24.1",
+    "responses==0.25.0",
     # loading test fixture data
-    "ruamel.yaml==0.18.5",
+    "ruamel.yaml==0.18.6",
     # Python 3.12 needs setuptools.
     "setuptools;python_version>='3.12'",
 ]

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/endpoint/activate.py

@@ -37,7 +37,7 @@ from globus_cli.termio import TextMode, display
 @click.option(
     "--myproxy-username",
     "-U",
-    help=("Give a username to use with --myproxy"),
+    help="Give a username to use with --myproxy",
 )
 @click.option("--myproxy-password", "-P", hidden=True)
 @click.option(
@@ -171,9 +171,9 @@ def endpoint_activate(
 
     # check if endpoint is already activated unless --force
     if not force:
-        res: (
-            dict[str, str] | globus_sdk.GlobusHTTPResponse
-        ) = transfer_client.endpoint_autoactivate(endpoint_id, if_expires_in=60)
+        res: dict[str, str] | globus_sdk.GlobusHTTPResponse = (
+            transfer_client.endpoint_autoactivate(endpoint_id, if_expires_in=60)
+        )
 
         if "AlreadyActivated" == res["code"]:
             display(

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/endpoint/create.py

@@ -117,9 +117,7 @@ For GCS, use the globus-connect-server CLI from your Endpoint."""
     endpoint_type = (
         EntityType.GCP_MAPPED
         if personal
-        else EntityType.GCSV4_HOST
-        if server
-        else EntityType.GCSV4_SHARE
+        else EntityType.GCSV4_HOST if server else EntityType.GCSV4_SHARE
     )
 
     # build options into a dict for kwarg-expansion

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/endpoint/server/list.py

@@ -38,9 +38,9 @@ def server_list(login_manager: LoginManager, *, endpoint_id: uuid.UUID) -> None:
     # raises usage error on shares for us
     endpoint_w_server_list = transfer_client.get_endpoint_w_server_list(endpoint_id)
     endpoint = endpoint_w_server_list[0]
-    server_list: (
-        str | dict[str, t.Any] | globus_sdk.GlobusHTTPResponse
-    ) = endpoint_w_server_list[1]
+    server_list: str | dict[str, t.Any] | globus_sdk.GlobusHTTPResponse = (
+        endpoint_w_server_list[1]
+    )
 
     if server_list == "S3":  # not GCS -- this is an S3 endpoint
         server_list = {"s3_url": endpoint["s3_url"]}

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/flows/create.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import uuid
+
 import click
 
 from globus_cli.commands.flows._common import (
@@ -36,6 +38,11 @@ ROLE_TYPES = ("flow_viewer", "flow_starter", "flow_administrator", "flow_owner")
 @starters_option
 @viewers_option
 @keywords_option
+@click.option(
+    "--subscription-id",
+    help="Set a subscription_id for the flow, marking it as subscription tier.",
+    type=click.UUID,
+)
 @LoginManager.requires_login("flows")
 def create_command(
     login_manager: LoginManager,
@@ -49,6 +56,7 @@ def create_command(
     starters: tuple[str, ...],
     viewers: tuple[str, ...],
     keywords: tuple[str, ...],
+    subscription_id: uuid.UUID | None,
 ) -> None:
     """
     Create a new flow.
@@ -98,6 +106,7 @@ def create_command(
         flow_starters=list(starters),
         flow_administrators=list(administrators),
         keywords=list(keywords),
+        subscription_id=subscription_id,
     )
 
     # Configure formatters for principals
@@ -114,6 +123,7 @@ def create_command(
         Field("Description", "description"),
         Field("Keywords", "keywords", formatter=formatters.ArrayFormatter()),
         Field("Owner", "flow_owner", formatter=principal_formatter),
+        Field("Subscription ID", "subscription_id"),
         Field("Created At", "created_at", formatter=formatters.Date),
         Field("Updated At", "updated_at", formatter=formatters.Date),
         Field(

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/flows/show.py

@@ -30,6 +30,7 @@ def show_command(login_manager: LoginManager, *, flow_id: uuid.UUID) -> None:
         Field("Title", "title"),
         Field("Keywords", "keywords", formatter=formatters.ArrayFormatter()),
         Field("Owner", "flow_owner", formatter=principal_formatter),
+        Field("Subscription ID", "subscription_id"),
         Field("Created At", "created_at", formatter=formatters.Date),
         Field("Updated At", "updated_at", formatter=formatters.Date),
         Field(

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/gcs/endpoint/__init__.py

@@ -4,7 +4,10 @@ from globus_cli.parsing import group
 @group(
     "endpoint",
     lazy_subcommands={
+        "role": (".role", "role_command"),
         "set-subscription-id": (".set_subscription_id", "set_subscription_id_command"),
+        "show": (".show", "show_command"),
+        "update": (".update", "update_command"),
     },
 )
 def endpoint_command() -> None:

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/_common.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+import typing as t
+
+from globus_cli.termio import Field, formatters
+from globus_cli.termio.formatters import FieldFormatter
+
+
+class NetworkUseFormatter(FieldFormatter[t.Union[str, t.Tuple[int, int]]]):
+    """
+    Custom Formatter to make network use associated fields better grouped.
+
+    Data is expected to be passed as a list of three elements:
+      [network_use, preferred, max]
+
+    Examples:
+      ("custom", 1, 2) -> "Preferred: 1, Max: 2"
+      ("aggressive", None, None) -> "aggressive"
+      ("normal", None, 3) -> "normal"
+    """
+
+    def parse(self, value: t.Any) -> str | tuple[int, int]:
+        if isinstance(value, list) and len(value) == 3:
+            if value[0] == "custom":
+                if isinstance(value[1], int) and isinstance(value[2], int):
+                    return value[1], value[2]
+            elif isinstance(value[0], str):
+                return value[0]
+
+        raise ValueError(
+            f"Invalid network use data shape. Expected [str, int, int]; found {value}."
+        )
+
+    def render(self, value: str | tuple[int, int]) -> str:
+        if isinstance(value, tuple):
+            return f"Preferred: {value[0]}, Max: {value[1]}"
+        return value
+
+
+# https://docs.globus.org/globus-connect-server/v5.4/api/schemas/Endpoint_1_2_0_schema/
+GCS_ENDPOINT_FIELDS = [
+    Field("Endpoint ID", "id"),
+    Field("Display Name", "display_name"),
+    Field("Allow UDT", "allow_udt", formatter=formatters.FuzzyBool),
+    Field("Contact Email", "contact_email"),
+    Field("Contact Info", "contact_info"),
+    Field("Department", "department"),
+    Field("Description", "description"),
+    Field("Earliest Last Access", "earliest_last_access", formatter=formatters.Date),
+    Field("GCS Manager URL", "gcs_manager_url"),
+    Field("GridFTP Control Channel Port", "gridftp_control_channel_port"),
+    Field("Info Link", "info_link"),
+    Field("Keywords", "keywords", formatter=formatters.Array),
+    Field("Network Use", "network_use"),
+    Field(
+        "Network Use (Concurrency)",
+        "[network_use, preferred_concurrency, max_concurrency]",
+        formatter=NetworkUseFormatter(),
+    ),
+    Field(
+        "Network Use (Parallelism)",
+        "[network_use, preferred_parallelism, max_parallelism]",
+        formatter=NetworkUseFormatter(),
+    ),
+    Field("Organization", "organization"),
+    Field("Public", "public", formatter=formatters.FuzzyBool),
+    Field("Subscription ID", "subscription_id"),
+]

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/role/__init__.py

@@ -0,0 +1,14 @@
+from globus_cli.parsing import group
+
+
+@group(
+    "role",
+    lazy_subcommands={
+        "create": (".create", "create_command"),
+        "delete": (".delete", "delete_command"),
+        "list": (".list", "list_command"),
+        "show": (".show", "show_command"),
+    },
+)
+def role_command() -> None:
+    """Manage Globus Connect Server (GCS) roles"""

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/role/_common.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+import typing as t
+
+from globus_cli.termio import Field
+from globus_cli.termio.formatters.auth import PrincipalURNFormatter
+
+if t.TYPE_CHECKING:
+    from globus_cli.services.auth import CustomAuthClient
+
+
+def role_fields(auth_client: CustomAuthClient) -> list[Field]:
+    return [
+        Field("ID", "id"),
+        Field("Role", "role"),
+        Field("Principal", "principal", formatter=PrincipalURNFormatter(auth_client)),
+    ]

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/role/create.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+import typing as t
+import uuid
+
+import click
+import globus_sdk
+
+from globus_cli.commands.gcs.endpoint.role._common import role_fields
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import command, endpoint_id_arg
+from globus_cli.termio import TextMode, display
+from globus_cli.utils import resolve_principal_urn
+
+_VALID_ROLES = t.Literal["administrator", "activity_manager", "activity_monitor"]
+
+
+@command("create")
+@endpoint_id_arg
+@click.argument("ROLE", type=click.Choice(t.get_args(_VALID_ROLES)), metavar="ROLE")
+@click.argument("PRINCIPAL", type=str)
+@click.option(
+    "--principal-type",
+    type=click.Choice(["identity", "group"]),
+    help="Qualifier to specify what type of principal (identity or group) is provided.",
+)
+@LoginManager.requires_login("transfer")
+def create_command(
+    login_manager: LoginManager,
+    *,
+    endpoint_id: uuid.UUID,
+    role: _VALID_ROLES,
+    principal: str,
+    principal_type: t.Literal["identity", "group"] | None,
+) -> None:
+    """
+    Create a role on a GCS Endpoint.
+
+    ROLE must be one of "administrator", "activity_manager", or "activity_monitor".
+
+    PRINCIPAL must be a username, UUID, or URN associated with a globus identity or
+    group.
+    If UUID, use `--principal-type` to specify the type (defaults to "identity").
+    """
+    gcs_client = login_manager.get_gcs_client(endpoint_id=endpoint_id)
+    auth_client = login_manager.get_auth_client()
+
+    # Format the principal into a URN
+    principal_urn = resolve_principal_urn(
+        auth_client=auth_client,
+        principal_type=principal_type,
+        principal=principal,
+    )
+
+    res = gcs_client.create_role(
+        globus_sdk.GCSRoleDocument(role=role, principal=principal_urn)
+    )
+
+    display(res, text_mode=TextMode.text_record, fields=role_fields(auth_client))

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/role/delete.py

@@ -0,0 +1,25 @@
+import uuid
+
+import click
+
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import command, endpoint_id_arg
+from globus_cli.termio import TextMode, display
+
+
+@command("delete")
+@endpoint_id_arg
+@click.argument("ROLE_ID", type=click.UUID)
+@LoginManager.requires_login("transfer")
+def delete_command(
+    login_manager: LoginManager,
+    *,
+    endpoint_id: uuid.UUID,
+    role_id: uuid.UUID,
+) -> None:
+    """Delete a role from a GCS Endpoint."""
+    gcs_client = login_manager.get_gcs_client(endpoint_id=endpoint_id)
+
+    res = gcs_client.delete_role(role_id)
+
+    display(res, text_mode=TextMode.text_raw, response_key="message")

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/role/list.py

@@ -0,0 +1,37 @@
+import uuid
+
+import click
+from globus_sdk.paging import Paginator
+
+from globus_cli.commands.gcs.endpoint.role._common import role_fields
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import command, endpoint_id_arg
+from globus_cli.termio import display
+from globus_cli.utils import PagingWrapper
+
+
+@command("list")
+@endpoint_id_arg
+@click.option(
+    "--all-roles", is_flag=True, help="Show all roles, not just yours.", default=False
+)
+@LoginManager.requires_login("transfer")
+def list_command(
+    login_manager: LoginManager,
+    *,
+    endpoint_id: uuid.UUID,
+    all_roles: bool,
+) -> None:
+    """List all roles on a GCS Endpoint associated with you."""
+    gcs_client = login_manager.get_gcs_client(endpoint_id=endpoint_id)
+    auth_client = login_manager.get_auth_client()
+
+    paginator = Paginator.wrap(gcs_client.get_role_list)
+    paginated_call = paginator(include="all_roles") if all_roles else paginator()
+    paging_wrapper = PagingWrapper(paginated_call.items(), json_conversion_key="DATA")
+
+    display(
+        paging_wrapper,
+        fields=role_fields(auth_client),
+        json_converter=paging_wrapper.json_converter,
+    )

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/role/show.py

@@ -0,0 +1,27 @@
+import uuid
+
+import click
+
+from globus_cli.commands.gcs.endpoint.role._common import role_fields
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import command, endpoint_id_arg
+from globus_cli.termio import TextMode, display
+
+
+@command("show")
+@endpoint_id_arg
+@click.argument("ROLE_ID", type=click.UUID)
+@LoginManager.requires_login("transfer")
+def show_command(
+    login_manager: LoginManager,
+    *,
+    endpoint_id: uuid.UUID,
+    role_id: uuid.UUID,
+) -> None:
+    """Describe a particular role on a GCS Endpoint."""
+    gcs_client = login_manager.get_gcs_client(endpoint_id=endpoint_id)
+    auth_client = login_manager.get_auth_client()
+
+    res = gcs_client.get_role(role_id)
+
+    display(res, text_mode=TextMode.text_record, fields=role_fields(auth_client))

{globus-cli-3.24.0 → globus-cli-3.25.0}/src/globus_cli/commands/gcs/endpoint/set_subscription_id.py

@@ -35,7 +35,7 @@ class GCSSubscriptionIdType(click.ParamType):
             self.fail(msg, param, ctx)
 
 
-@command("set-subscription-id", short_help="Update an endpoint's subscription")
+@command("set-subscription-id", short_help="Set a GCS Endpoint's subscription.")
 @endpoint_id_arg
 @click.argument("SUBSCRIPTION_ID", type=GCSSubscriptionIdType())
 @LoginManager.requires_login("transfer")

globus-cli-3.25.0/src/globus_cli/commands/gcs/endpoint/show.py

@@ -0,0 +1,22 @@
+import uuid
+
+from globus_cli.commands.gcs.endpoint._common import GCS_ENDPOINT_FIELDS
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import command, endpoint_id_arg
+from globus_cli.termio import TextMode, display
+
+
+@command("show")
+@endpoint_id_arg
+@LoginManager.requires_login("transfer")
+def show_command(
+    login_manager: LoginManager,
+    *,
+    endpoint_id: uuid.UUID,
+) -> None:
+    """Display information about a particular GCS Endpoint."""
+    gcs_client = login_manager.get_gcs_client(endpoint_id=endpoint_id)
+
+    res = gcs_client.get_endpoint()
+
+    display(res, text_mode=TextMode.text_record, fields=GCS_ENDPOINT_FIELDS)