feat(cli): add table/json output formats for repo commands

.gitignore

@@ -160,7 +160,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
 
 # Ruff linter cache directory
 .ruff_cache

pyproject.toml

@@ -9,6 +9,7 @@ dependencies = [
     "requests>=2.31.0",
     "rich>=14.0.0",
     "dynaconf>=3.2.11",
+    "prettytable>=3.16.0",
 ]
 readme = "README.md"
 requires-python = ">= 3.11.5"

src/github_rest_cli/api.py

@@ -1,6 +1,6 @@
 import requests
 from github_rest_cli.globals import GITHUB_URL, get_headers
-from github_rest_cli.utils import rich_output, rprint
+from github_rest_cli.utils import rich_output, CliOutput
 
 
 def request_with_handling(
@@ -50,7 +50,7 @@ def fetch_user() -> str:
     return None
 
 
-def get_repository(name: str, org: str = None):
+def get_repository(name: str, org: str = None, output_format: str = "table"):
     owner = org if org else fetch_user()
     headers = get_headers()
     url = build_url("repos", owner, name)
@@ -65,10 +65,40 @@ def get_repository(name: str, org: str = None):
         },
     )
 
-    if response:
-        data = response.json()
-        rprint(data)
-    return None
+    if not response:
+        return None
+
+    data = response.json()
+
+    if output_format == "json":
+        return CliOutput(data).get_json_output()
+
+    return CliOutput([data]).default_format()
+
+
+def list_repositories(page: int, property: str, role: str, output_format: str):
+    headers = get_headers()
+    url = build_url("user", "repos")
+
+    params = {"per_page": page, "sort": property, "type": role}
+
+    response = request_with_handling(
+        "GET",
+        url,
+        params=params,
+        headers=headers,
+        error_msg={401: "Unauthorized access. Please check your token or credentials."},
+    )
+
+    if not response:
+        return None
+
+    output = CliOutput(response.json())
+
+    if output_format == "json":
+        return output.json_format()
+
+    return output.default_format()
 
 
 def create_repository(name: str, visibility: str, org: str = None, empty: bool = False):
@@ -118,28 +148,6 @@ def delete_repository(name: str, org: str = None):
     )
 
 
-def list_repositories(page: int, property: str, role: str):
-    headers = get_headers()
-    url = build_url("user", "repos")
-
-    params = {"per_page": page, "sort": property, "type": role}
-
-    response = request_with_handling(
-        "GET",
-        url,
-        params=params,
-        headers=headers,
-        error_msg={401: "Unauthorized access. Please check your token or credentials."},
-    )
-
-    if response:
-        data = response.json()
-        repo_full_name = [repo["full_name"] for repo in data]
-        for repos in repo_full_name:
-            rich_output(f"- {repos}")
-        rich_output(f"\nTotal repositories: {len(repo_full_name)}")
-
-
 def dependabot_security(name: str, enabled: bool, org: str = None):
     is_enabled = bool(enabled)
 

src/github_rest_cli/main.py

@@ -29,7 +29,7 @@ def cli():
 
     subparsers = parser.add_subparsers(help="GitHub REST API commands", dest="command")
 
-    # Subparser for "get-repository" function
+    # Subparser for "get-repo" function
     get_repo_parser = subparsers.add_parser(
         "get-repo", help="Get a repository's details"
     )
@@ -43,9 +43,18 @@ def cli():
     get_repo_parser.add_argument(
         "-o", "--org", help="The organization name", required=False, dest="org"
     )
+    get_repo_parser.add_argument(
+        "-f",
+        "--format",
+        required=False,
+        default="table",
+        choices=["table", "json"],
+        dest="format",
+        help="Format to display the repository in",
+    )
     get_repo_parser.set_defaults(func=get_repository)
 
-    # Subparser for "list-repository" function
+    # Subparser for "list-repo" function
     list_repo_parser = subparsers.add_parser(
         "list-repo",
         help="List your repositories",
@@ -61,7 +70,7 @@ def cli():
         "-p",
         "--page",
         required=False,
-        default=50,
+        default=20,
         type=int,
         dest="page",
         help="The number of results",
@@ -74,6 +83,15 @@ def cli():
         dest="sort",
         help="List repositories sorted by",
     )
+    list_repo_parser.add_argument(
+        "-f",
+        "--format",
+        required=False,
+        default="table",
+        choices=["table", "json"],
+        dest="format",
+        help="Format to display the list of repositories in",
+    )
     list_repo_parser.set_defaults(func=list_repositories)
 
     # Subparser for "create-repository" function
@@ -201,9 +219,13 @@ def cli():
 
     if hasattr(args, "func"):
         if command == "get-repo":
-            args.func(args.name, args.org)
+            repo = args.func(args.name, args.org, args.format)
+            if repo is not None:
+                print(repo)  # noqa: T201
         elif command == "list-repo":
-            args.func(args.page, args.sort, args.role)
+            repos = args.func(args.page, args.sort, args.role, args.format)
+            if repos is not None:
+                print(repos)  # noqa: T201
         elif command == "create-repo":
             args.func(args.name, args.visibility, args.org, args.empty)
         elif command == "delete-repo":

src/github_rest_cli/utils.py

@@ -1,5 +1,75 @@
 from rich import print as rprint
+import json
+
+
+class CliFormatOutput:
+    def to_json(self, data):
+        return json.dumps(data, indent=2)
+
+    def to_table(self, fields, data):
+        from prettytable import PrettyTable
+
+        table = PrettyTable()
+        table.title = "GitHub Repositories"
+        table.header_style = "upper"
+
+        if isinstance(fields, list):
+            table.field_names = fields
+
+            # Align all columns to left.
+            table.align = "l"
+
+        if isinstance(data, list):
+            for row in data:
+                table.add_row(row)
+
+        return table
+
+
+class CliOutput:
+    # What's the role of `data` here?
+    # `data` is a parameter of the __init__ method, provided when creating an instance.
+    # When you create an instance of the CliOutput class,
+    # `self.data` stores the value of the `data` parameter as an instance attribute.
+    def __init__(self, data):
+        self.data = data
+        self.formatter = CliFormatOutput()
+
+    def json_format(self):
+        repos = {
+            "repositories": [
+                {
+                    "name": f.get("name"),
+                    "owner": f.get("owner", {}).get("login"),
+                    "url": f.get("html_url"),
+                    "visibility": f.get("visibility"),
+                }
+                for f in self.data
+            ],
+        }
+        return self.formatter.to_json(repos)
+
+    def table_format(self):
+        fields = ["name", "owner", "url", "visibility"]
+        values = []
+        for repo in self.data:
+            values.append(
+                [
+                    repo.get("name"),
+                    repo.get("owner", {}).get("login"),
+                    repo.get("html_url"),
+                    repo.get("visibility"),
+                ]
+            )
+
+        return self.formatter.to_table(fields, values)
+
+    def get_json_output(self):
+        return self.formatter.to_json(self.data)
+
+    def default_format(self):
+        return self.table_format()
 
 
 def rich_output(message: str, format_str: str = "bold green"):
-    rprint(f"[{format_str}]{message}[/{format_str}]")
+    return rprint(f"[{format_str}]{message}[/{format_str}]")

tests/test_api.py

@@ -42,3 +42,62 @@ def test_create_repository_org(mocker):
     result = api.create_repository("test-repo", "public", "test-org")
 
     assert result == expected_message
+
+
+SAMPLE_REPO = {
+    "name": "test-repo",
+    "owner": {"login": "test-user"},
+    "html_url": "https://github.com/test-user/test-repo",
+    "visibility": "public",
+}
+
+
+def _mock_repo_response(mocker, payload):
+    mocker.patch(GET_HEADERS_FUNCTION, return_value={"Authorization": "token fake"})
+    mocker.patch(FETCH_USER_FUNCTION, return_value="test-user")
+
+    mock_response = mocker.Mock()
+    mock_response.status_code = 200
+    mock_response.json.return_value = payload
+    mocker.patch(REQUEST_HANDLER_FUNCTION, return_value=mock_response)
+
+
+def test_get_repository_json_format(mocker):
+    _mock_repo_response(mocker, SAMPLE_REPO)
+
+    result = api.get_repository("test-repo", output_format="json")
+
+    assert isinstance(result, str)
+    assert '"name": "test-repo"' in result
+    assert '"visibility": "public"' in result
+
+
+def test_get_repository_table_format(mocker):
+    _mock_repo_response(mocker, SAMPLE_REPO)
+
+    result = api.get_repository("test-repo", output_format="table")
+
+    table_text = str(result)
+    assert "test-repo" in table_text
+    assert "test-user" in table_text
+    assert not table_text.strip().startswith("{")
+
+
+def test_list_repositories_json_format(mocker):
+    _mock_repo_response(mocker, [SAMPLE_REPO])
+
+    result = api.list_repositories(20, "pushed", None, "json")
+
+    assert isinstance(result, str)
+    assert '"repositories"' in result
+    assert '"name": "test-repo"' in result
+
+
+def test_list_repositories_table_format(mocker):
+    _mock_repo_response(mocker, [SAMPLE_REPO])
+
+    result = api.list_repositories(20, "pushed", None, "table")
+
+    table_text = str(result)
+    assert "test-repo" in table_text
+    assert "GITHUB REPOSITORIES" in table_text.upper()