yellowdog-python-examples 7.16.4__tar.gz → 7.16.6__tar.gz

{yellowdog_python_examples-7.16.4/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.16.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.16.4
+Version: 7.16.6
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/README.md

@@ -2720,10 +2720,12 @@ The `yd-terminate` command immediately terminates Compute Requirements that matc
 The `yd-list` command is used to list various YellowDog items, using the `namespace` and `tag` properties (if applicable) to target the scope of what to list:
 
 - Allowances
+- Applications
 - Attribute Definitions
 - Compute Requirement Templates
 - Compute Requirements
 - Compute Source Templates
+- Groups
 - Image Families, Image Groups, and Images
 - Instances
 - Keyrings
@@ -2731,8 +2733,10 @@ The `yd-list` command is used to list various YellowDog items, using the `namesp
 - Namespace Storage Configurations
 - Nodes
 - Objects in the Object Store
+- Roles
 - Task Groups
 - Tasks
+- Users
 - Work Requirements
 - Worker Pools
 - Workers
@@ -2811,6 +2815,10 @@ The `yd-show` command will show the details (in JSON) of any YellowDog entity th
 - Image Families, Image Groups, and Images
 - Keyrings
 - Allowances
+- Users
+- Applications
+- Groups
+- Roles
 
 ## yd-compare
 

yellowdog_python_examples-7.16.6/yellowdog_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.16.6"

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/create.py

@@ -337,11 +337,12 @@ def create_compute_requirement_template(resource: Dict):
         print_json(resource)
         return
 
-    # Overwrite source dictionaries with ComputeSourceUsage objects
-    resource[PROP_SOURCES] = [
-        _get_model_object("ComputeSourceUsage", source)
-        for source in resource.get(PROP_SOURCES, [])
-    ]
+    # Overwrite source dictionaries with ComputeSourceUsage objects for static CRTs
+    if resource.get(PROP_SOURCES) is not None:
+        resource[PROP_SOURCES] = [
+            _get_model_object("ComputeSourceUsage", source)
+            for source in resource.get(PROP_SOURCES, [])
+        ]
 
     compute_template = _get_model_object(type, resource)
 

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/list.py

@@ -15,11 +15,16 @@ from yellowdog_client.common import SearchClient
 from yellowdog_client.model import (
     Allowance,
     AllowanceSearch,
+    Application,
+    ApplicationSearch,
     ComputeRequirement,
     ComputeRequirementSearch,
     ComputeRequirementStatus,
     ComputeRequirementTemplateSummary,
     ComputeSourceTemplateSummary,
+    Group,
+    GroupSearch,
+    GroupSummary,
     Instance,
     InstanceSearch,
     Keyring,
@@ -33,8 +38,13 @@ from yellowdog_client.model import (
     NodeSearch,
     NodeStatus,
     ObjectDetail,
+    Role,
+    RoleSearch,
+    RoleSummary,
     Task,
     TaskGroup,
+    User,
+    UserSearch,
     Worker,
     WorkerPoolStatus,
     WorkerPoolSummary,
@@ -114,6 +124,14 @@ def main():
         list_attribute_definitions()
     elif ARGS_PARSER.namespace_policies:
         list_namespace_policies()
+    elif ARGS_PARSER.users:
+        list_users()
+    elif ARGS_PARSER.applications:
+        list_applications()
+    elif ARGS_PARSER.groups:
+        list_groups()
+    elif ARGS_PARSER.roles:
+        list_roles()
 
 
 def check_for_valid_option() -> bool:
@@ -122,9 +140,11 @@ def check_for_valid_option() -> bool:
     """
     if [
         ARGS_PARSER.allowances,
+        ARGS_PARSER.applications,
         ARGS_PARSER.attribute_definitions,
         ARGS_PARSER.compute_requirements,
         ARGS_PARSER.compute_templates,
+        ARGS_PARSER.groups,
         ARGS_PARSER.image_families,
         ARGS_PARSER.instances,
         ARGS_PARSER.keyrings,
@@ -133,8 +153,10 @@ def check_for_valid_option() -> bool:
         ARGS_PARSER.nodes,
         ARGS_PARSER.object_paths,
         ARGS_PARSER.source_templates,
+        ARGS_PARSER.roles,
         ARGS_PARSER.task_groups,
         ARGS_PARSER.tasks,
+        ARGS_PARSER.users,
         ARGS_PARSER.work_requirements,
         ARGS_PARSER.worker_pools,
         ARGS_PARSER.workers,
@@ -846,6 +868,102 @@ def list_namespace_policies():
             print_json(details)
 
 
+def list_users():
+    """
+    List all users in the account.
+    """
+    user_search = UserSearch()
+    search_client: SearchClient = CLIENT.account_client.get_users(user_search)
+    users: List[User] = search_client.list_all()
+
+    users.sort(key=lambda user: user.name)
+
+    if len(users) == 0:
+        print_log("No Users to display")
+        return
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, users, object_type_name="User")
+        return
+
+    for selected_users in select(CLIENT, users, object_type_name="User"):
+        print_yd_object(selected_users)
+
+
+def list_applications():
+    """
+    List all applications in the account.
+    """
+    application_search = ApplicationSearch()
+    search_client: SearchClient = CLIENT.account_client.get_applications(
+        application_search
+    )
+    applications: List[Application] = search_client.list_all()
+    applications.sort(key=lambda app: app.name)
+
+    if len(applications) == 0:
+        print_log("No Applications to display")
+        return
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, applications, object_type_name="Application")
+        return
+
+    for selected_users in select(CLIENT, applications, object_type_name="Application"):
+        print_yd_object(selected_users)
+
+
+def list_groups():
+    """
+    List all groups in the account.
+    """
+    group_search = GroupSearch()
+    search_client: SearchClient = CLIENT.account_client.get_groups(group_search)
+    group_summaries: List[GroupSummary] = search_client.list_all()
+
+    if len(group_summaries) == 0:
+        print_log("No Groups to display")
+        return
+
+    group_summaries.sort(key=lambda group: group.name if group.name is not None else "")
+
+    groups: List[Group] = [
+        CLIENT.account_client.get_group(x.id) for x in group_summaries
+    ]
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, groups, object_type_name="Group")
+        return
+
+    for selected_users in select(CLIENT, groups, object_type_name="Group"):
+        print_yd_object(selected_users)
+
+
+def list_roles():
+    """
+    List all roles in the account.
+    """
+    role_search = RoleSearch()
+    search_client: SearchClient = CLIENT.account_client.get_roles(role_search)
+    role_summaries: List[RoleSummary] = search_client.list_all()
+
+    if len(role_summaries) == 0:
+        print_log("No Roles to display")
+        return
+
+    role_summaries.sort(key=lambda role: role.name if role.name is not None else "")
+
+    print_log("Obtaining permissions for each role ...")
+    roles: List[Role] = [CLIENT.account_client.get_role(x.id) for x in role_summaries]
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, roles, object_type_name="Role")
+        return
+
+    for selected_users in select(CLIENT, roles, object_type_name="Role"):
+        print_yd_object(selected_users)
+
+
 def get_autoscaling_capacity(namespace: str) -> Dict:
     """
     Get the current autoscaling values for a namespace.

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/submit.py

@@ -1191,6 +1191,8 @@ def get_task_data_property(
             ) as f:
                 return f.read()
 
+    return None
+
 
 def follow_progress_old(work_requirement: WorkRequirement) -> None:
     """

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/utils/args.py

@@ -627,6 +627,30 @@ class CLIParser:
                 required=False,
                 help="list namespace policies",
             )
+            parser.add_argument(
+                "--users",
+                action="store_true",
+                required=False,
+                help="list users",
+            )
+            parser.add_argument(
+                "--applications",
+                action="store_true",
+                required=False,
+                help="list applications",
+            )
+            parser.add_argument(
+                "--groups",
+                action="store_true",
+                required=False,
+                help="list groups",
+            )
+            parser.add_argument(
+                "--roles",
+                action="store_true",
+                required=False,
+                help="list roles",
+            )
             parser.add_argument(
                 "--output-file",
                 type=str,
@@ -1501,6 +1525,26 @@ class CLIParser:
     def namespace_policies(self) -> Optional[bool]:
         return self.args.namespace_policies
 
+    @property
+    @allow_missing_attribute
+    def users(self) -> Optional[bool]:
+        return self.args.users
+
+    @property
+    @allow_missing_attribute
+    def applications(self) -> Optional[bool]:
+        return self.args.applications
+
+    @property
+    @allow_missing_attribute
+    def groups(self) -> Optional[bool]:
+        return self.args.groups
+
+    @property
+    @allow_missing_attribute
+    def roles(self) -> Optional[bool]:
+        return self.args.roles
+
     @property
     @allow_missing_attribute
     def show_keyring_passwords(self) -> Optional[bool]:

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/utils/items.py

@@ -6,11 +6,13 @@ from typing import TypeVar
 
 from yellowdog_client.model import (
     Allowance,
+    Application,
     ComputeRequirement,
     ComputeRequirementTemplateSummary,
     ComputeSourceTemplate,
     ComputeSourceTemplateSummary,
     ConfiguredWorkerPool,
+    Group,
     Instance,
     KeyringSummary,
     MachineImageFamilySummary,
@@ -19,8 +21,10 @@ from yellowdog_client.model import (
     Node,
     ObjectPath,
     ProvisionedWorkerPool,
+    Role,
     Task,
     TaskGroup,
+    User,
     Worker,
     WorkerPoolSummary,
     WorkRequirementSummary,
@@ -32,22 +36,26 @@ Item = TypeVar(
     "Item",
     AWSAvailabilityZone,
     Allowance,
+    Application,
     ComputeRequirement,
     ComputeRequirementTemplateSummary,
     ComputeSourceTemplate,
     ComputeSourceTemplateSummary,
     ConfiguredWorkerPool,
+    Group,
     Instance,
     KeyringSummary,
     MachineImageFamilySummary,
     NamespacePolicy,
     NamespaceStorageConfiguration,
+    Node,
     ObjectPath,
     ProvisionedWorkerPool,
+    Role,
     Task,
     TaskGroup,
-    Worker,
+    User,
     WorkRequirementSummary,
+    Worker,
     WorkerPoolSummary,
-    Node,
 )

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/utils/printing.py

@@ -21,6 +21,7 @@ from yellowdog_client import PlatformClient
 from yellowdog_client.common.json import Json
 from yellowdog_client.model import (
     Allowance,
+    Application,
     BestComputeSourceReport,
     BestComputeSourceReportSource,
     ComputeRequirement,
@@ -30,7 +31,10 @@ from yellowdog_client.model import (
     ComputeRequirementTemplateUsage,
     ComputeSourceTemplateSummary,
     ConfiguredWorkerPool,
+    ExternalUser,
+    Group,
     Instance,
+    InternalUser,
     KeyringSummary,
     MachineImageFamilySummary,
     NamespacePolicy,
@@ -39,8 +43,10 @@ from yellowdog_client.model import (
     ObjectPath,
     ProvisionedWorkerPool,
     ProvisionedWorkerPoolProperties,
+    Role,
     Task,
     TaskGroup,
+    User,
     Worker,
     WorkerPoolSummary,
     WorkRequirement,
@@ -62,6 +68,7 @@ from yellowdog_cli.utils.settings import (
     HIGHLIGHTED_STATES,
     JSON_INDENT,
     MAX_LINES_COLOURED_FORMATTING,
+    MAX_TABLE_DESCRIPTION,
     NAMESPACE_OBJECT_STORE_PREFIX_SEPARATOR,
     PROP_RESOURCE,
     WARNING_STYLE,
@@ -395,6 +402,7 @@ def compute_requirement_template_table(
         "Name",
         "Namespace",
         "Type",
+        "Description",
         "Strategy Type",
         "Compute Requirement Template ID",
     ]
@@ -416,6 +424,7 @@ def compute_requirement_template_table(
                 crt_summary.name,
                 crt_summary.namespace,
                 type,
+                _truncate_text(crt_summary.description),
                 strategy_type,
                 crt_summary.id,
             ]
@@ -430,6 +439,7 @@ def compute_source_template_table(
         "#",
         "Name",
         "Namespace",
+        "Description",
         "Provider",
         "Type",
         "Compute Source Template ID",
@@ -449,6 +459,7 @@ def compute_source_template_table(
                 index + 1,
                 cst_summary.name,
                 cst_summary.namespace,
+                _truncate_text(cst_summary.description),
                 provider,
                 type,
                 cst_summary.id,
@@ -472,7 +483,7 @@ def keyring_table(
             [
                 index + 1,
                 keyring.name,
-                keyring.description,
+                _truncate_text(keyring.description),
                 keyring.id,
             ]
         )
@@ -628,7 +639,7 @@ def allowances_table(
             [
                 index + 1,
                 allowance.type.split(".")[-1],
-                allowance.description,
+                _truncate_text(allowance.description),
                 allowance.allowedHours,
                 allowance.remainingHours,
                 allowance.limitEnforcement,
@@ -661,7 +672,7 @@ def attribute_definitions_table(
                 attribute_definition["name"],
                 attribute_definition["type"].split(".")[-1],
                 attribute_definition["title"],
-                attribute_definition.get("description", ""),
+                _truncate_text(attribute_definition.get("description", "")),
             ]
         )
     return headers, table
@@ -709,6 +720,115 @@ def namespace_policies_table(
     return headers, table
 
 
+def users_table(
+    users: List[User],
+) -> (List[str], List[List]):
+    headers = [
+        "#",
+        "Name",
+        "User Type",
+        "Username",
+        "Email",
+        "ID",
+    ]
+    table = []
+    for index, user in enumerate(users):
+        if isinstance(user, InternalUser):
+            table.append(
+                [
+                    index + 1,
+                    user.name,
+                    "Internal",
+                    user.username,
+                    user.email,
+                    user.id,
+                ]
+            )
+        elif isinstance(user, ExternalUser):  # External user
+            table.append(
+                [
+                    index + 1,
+                    user.name,
+                    "External",
+                    "",
+                    user.email,
+                    user.id,
+                ]
+            )
+    return headers, table
+
+
+def applications_table(
+    applications: List[Application],
+) -> (List[str], List[List]):
+    headers = [
+        "#",
+        "Name",
+        "Description",
+        "ID",
+    ]
+    table = []
+    for index, application in enumerate(applications):
+        table.append(
+            [
+                index + 1,
+                application.name,
+                _truncate_text(application.description),
+                application.id,
+            ]
+        )
+    return headers, table
+
+
+def groups_table(
+    groups: List[Group],
+) -> (List[str], List[List]):
+    headers = [
+        "#",
+        "Name",
+        "Admin Group?",
+        "Description",
+        "Roles",
+        "ID",
+    ]
+    table = []
+    for index, group in enumerate(groups):
+        table.append(
+            [
+                index + 1,
+                group.name,
+                group.adminGroup,
+                _truncate_text(group.description),
+                ", ".join([x.role.name for x in group.roles]),
+                group.id,
+            ]
+        )
+    return headers, table
+
+
+def roles_table(
+    roles: List[Role],
+) -> (List[str], List[List]):
+    headers = [
+        "#",
+        "Name",
+        "Permissions",
+        "ID",
+    ]
+    table = []
+    for index, role in enumerate(roles):
+        permissions = ", ".join(sorted([x.value for x in role.permissions]))
+        table.append(
+            [
+                index + 1,
+                role.name,
+                _truncate_text(permissions),
+                role.id,
+            ]
+        )
+    return headers, table
+
+
 def print_numbered_object_list(
     client: PlatformClient,
     objects: List[Union[Item, str, Dict]],
@@ -769,6 +889,14 @@ def print_numbered_object_list(
         headers, table = nodes_table(objects)
     elif isinstance(objects[0], Worker):
         headers, table = workers_table(objects)
+    elif isinstance(objects[0], User):
+        headers, table = users_table(objects)
+    elif isinstance(objects[0], Application):
+        headers, table = applications_table(objects)
+    elif isinstance(objects[0], Group):
+        headers, table = groups_table(objects)
+    elif isinstance(objects[0], Role):
+        headers, table = roles_table(objects)
     else:
         table = []
         for index, obj in enumerate(objects):
@@ -1322,3 +1450,13 @@ def _print_to_file(json_string: str, output_file: str, with_final_comma: bool =
         raise Exception(f"Cannot open output file for writing: {e}")
 
     FIRST_OUTPUT_TO_FILE = False
+
+
+def _truncate_text(description: Union[str, None]):
+    """
+    Truncate a description to fit within MAX_TABLE_DESCRIPTION.
+    """
+    if description is None:
+        return ""
+
+    return f"{description[:MAX_TABLE_DESCRIPTION - 3] + '...' if len(description) > MAX_TABLE_DESCRIPTION else description}"

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6}/yellowdog_cli/utils/settings.py

@@ -43,6 +43,7 @@ TOML_VAR_NESTED_DEPTH = 3
 VAR_NAME_OF_UNNAMED_TASK = "none"
 
 DEFAULT_LOG_WIDTH = 120
+MAX_TABLE_DESCRIPTION = 50
 MAX_LINES_COLOURED_FORMATTING = 1024
 ERROR_STYLE = "bold red3"
 WARNING_STYLE = "red3"

{yellowdog_python_examples-7.16.4 → yellowdog_python_examples-7.16.6/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.16.4
+Version: 7.16.6
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

yellowdog_python_examples-7.16.4/yellowdog_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.16.4"