Enhance project show command to support displaying specific project details by ID

Author: axif0

capture_tests/expected_captures.txt

@@ -75,7 +75,7 @@ Stdout: 30 bytes
 Stderr: 0 bytes
 
 Stdout:
-cbrain cli client version 0.9
+cbrain cli client version 1.0
 Stderr:
 (No output)
 
@@ -418,33 +418,45 @@ Stderr:
 ############################
 Command: cbrain         project show 10
 Status: 0
-Stdout: TOFIX bytes
+Stdout: 198 bytes
 Stderr: 0 bytes
 
 Stdout:
-TOFIX
+PROJECT DETAILS
+------------------------------
+Field     Value    
+--------- ---------
+ID        10
+Name      NormTest1
+Type      WorkGroup
+Site ID   N/A
+Invisible N/A
 Stderr:
 (No output)
 
 ############################
 Command: cbrain --json  project show 10
 Status: 0
-Stdout: TOFIX bytes
+Stdout: 85 bytes
 Stderr: 0 bytes
 
 Stdout:
-TOFIX
+{
+  "id": 10,
+  "name": "NormTest1",
+  "type": "WorkGroup"
+}
 Stderr:
 (No output)
 
 ############################
 Command: cbrain --jsonl project show 10
 Status: 0
-Stdout: TOFIX bytes
+Stdout: 48 bytes
 Stderr: 0 bytes
 
 Stdout:
-TOFIX
+{"id":10,"name":"NormTest1","type":"WorkGroup"}
 Stderr:
 (No output)
 
@@ -495,7 +507,7 @@ Stderr:
 ############################
 Command: cbrain --json  project switch all
 Status: 0
-Stdout: 40 bytes
+Stdout: 56 bytes
 Stderr: 0 bytes
 
 Stdout:
@@ -506,7 +518,7 @@ Stderr:
 ############################
 Command: cbrain --jsonl project switch all
 Status: 0
-Stdout: 40 bytes
+Stdout: 56 bytes
 Stderr: 0 bytes
 
 Stdout:
@@ -644,7 +656,7 @@ Stderr:
 
 ############################
 Command: cbrain         tag update 99 --name Renamed --user-id 2 --group-id 3
-Status: 0
+Status: 1
 Stdout: 37 bytes
 Stderr: 0 bytes
 
@@ -1117,6 +1129,7 @@ Stderr: 0 bytes
 Stdout:
 Authentication error (401): Unauthorized
 Error: Access denied. Please log in using authorized credentials.
+Stderr:
 (No output)
 
 ############################

cbrain_cli/data/projects.py

@@ -71,48 +71,70 @@ def switch_project(args):
 
 def show_project(args):
     """
-    Get the current project/group from credentials.
+    Get the current project/group from credentials or show a specific project by ID.
 
     Parameters
     ----------
     args : argparse.Namespace
-        Command line arguments
+        Command line arguments, may include project_id
 
     Returns
     -------
     dict or None
         Dictionary containing project details if successful, None if no project set
     """
-    with open(CREDENTIALS_FILE) as f:
-        credentials = json.load(f)
-
-    current_group_id = credentials.get("current_group_id")
-    if not current_group_id:
-        return None
-
-    # Get fresh group details from server
-    group_endpoint = f"{cbrain_url}/groups/{current_group_id}"
-    headers = auth_headers(api_token)
-
-    request = urllib.request.Request(group_endpoint, data=None, headers=headers, method="GET")
-
-    try:
-        with urllib.request.urlopen(request) as response:
-            data = response.read().decode("utf-8")
-            group_data = json.loads(data)
-            return group_data
-
-    except urllib.error.HTTPError as e:
-        if e.code == 404:
-            print(f"Error: Current project (ID {current_group_id}) no longer exists")
-            # Clear the invalid group_id from credentials
-            credentials.pop("current_group_id", None)
-            credentials.pop("current_group_name", None)
-            with open(CREDENTIALS_FILE, "w") as f:
-                json.dump(credentials, f, indent=2)
+    # Check if a specific project ID was provided
+    project_id = getattr(args, "project_id", None)
+
+    if project_id:
+        # Show specific project by ID
+        group_endpoint = f"{cbrain_url}/groups/{project_id}"
+        headers = auth_headers(api_token)
+        request = urllib.request.Request(group_endpoint, data=None, headers=headers, method="GET")
+
+        try:
+            with urllib.request.urlopen(request) as response:
+                data = response.read().decode("utf-8")
+                group_data = json.loads(data)
+                return group_data
+        except urllib.error.HTTPError as e:
+            if e.code == 404:
+                print(f"Error: Project with ID {project_id} not found")
+                return None
+            else:
+                raise
+    else:
+        # Show current project from credentials
+        with open(CREDENTIALS_FILE) as f:
+            credentials = json.load(f)
+
+        current_group_id = credentials.get("current_group_id")
+        if not current_group_id:
             return None
-        else:
-            raise
+
+        # Get fresh group details from server
+        group_endpoint = f"{cbrain_url}/groups/{current_group_id}"
+        headers = auth_headers(api_token)
+
+        request = urllib.request.Request(group_endpoint, data=None, headers=headers, method="GET")
+
+        try:
+            with urllib.request.urlopen(request) as response:
+                data = response.read().decode("utf-8")
+                group_data = json.loads(data)
+                return group_data
+
+        except urllib.error.HTTPError as e:
+            if e.code == 404:
+                print(f"Error: Current project (ID {current_group_id}) no longer exists")
+                # Clear the invalid group_id from credentials
+                credentials.pop("current_group_id", None)
+                credentials.pop("current_group_name", None)
+                with open(CREDENTIALS_FILE, "w") as f:
+                    json.dump(credentials, f, indent=2)
+                return None
+            else:
+                raise
 
 
 def list_projects(args):

cbrain_cli/formatter/projects_fmt.py

@@ -45,6 +45,49 @@ def print_current_project(project_data):
     print(f'Current project is "{group_name}" ID={group_id}')
 
 
+def print_project_details(project_data, args):
+    """
+    Print detailed information about a specific project.
+
+    Parameters
+    ----------
+    project_data : dict
+        Dictionary containing project details
+    args : argparse.Namespace
+        Command line arguments, including the --json flag
+    """
+    if getattr(args, "json", False):
+        json_printer(project_data)
+        return
+    elif getattr(args, "jsonl", False):
+        jsonl_printer(project_data)
+        return
+
+    print("PROJECT DETAILS")
+    print("-" * 30)
+
+    # Basic project information
+    basic_info = [
+        {"field": "ID", "value": str(project_data.get("id", "N/A"))},
+        {"field": "Name", "value": str(project_data.get("name", "N/A"))},
+        {"field": "Type", "value": str(project_data.get("type", "N/A"))},
+        {"field": "Site ID", "value": str(project_data.get("site_id", "N/A"))},
+        {"field": "Invisible", "value": str(project_data.get("invisible", "N/A"))},
+    ]
+
+    dynamic_table_print(basic_info, ["field", "value"], ["Field", "Value"])
+
+    # Display description if available
+    if project_data.get("description"):
+        print()
+        print("DESCRIPTION")
+        print("-" * 30)
+        description = project_data.get("description").strip()
+        # Handle multi-line descriptions
+        for line in description.split("\n"):
+            print(f"{line}")
+
+
 def print_no_project():
     """
     Print message when no current project is set.

cbrain_cli/handlers.py

@@ -153,12 +153,24 @@ def handle_project_switch(args):
 
 
 def handle_project_show(args):
-    """Display information about the currently active project or indicate if none is set."""
+    """Display information about the currently active project or a specific project by ID."""
     result = show_project(args)
     if result:
-        print_current_project(result)
+        # Check if a specific project ID was requested
+        project_id = getattr(args, "project_id", None)
+        if project_id:
+            # Show detailed project information for specific project
+            from cbrain_cli.formatter.projects_fmt import print_project_details
+
+            print_project_details(result, args)
+        else:
+            # Show current project information
+            print_current_project(result)
     else:
-        print_no_project()
+        # Only show "no project" message if no specific ID was requested
+        project_id = getattr(args, "project_id", None)
+        if not project_id:
+            print_no_project()
 
 
 def handle_project_unswitch(args):

cbrain_cli/main.py

@@ -212,7 +212,12 @@ def main():
     project_switch_parser.set_defaults(func=handle_errors(handle_project_switch))
 
     # project show
-    project_show_parser = project_subparsers.add_parser("show", help="Show current project")
+    project_show_parser = project_subparsers.add_parser(
+        "show", help="Show current project or specific project by ID"
+    )
+    project_show_parser.add_argument(
+        "project_id", type=int, nargs="?", help="Project ID to show (optional)"
+    )
     project_show_parser.set_defaults(func=handle_errors(handle_project_show))
 
     # project unswitch