fivetran-cli 0.1.1__tar.gz → 0.1.3__tar.gz

{fivetran_cli-0.1.1/src/fivetran_cli.egg-info → fivetran_cli-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fivetran-cli
-Version: 0.1.1
+Version: 0.1.3
 Summary: Command line wrapper for the Fivetran REST API
 Author: Fivetran
 License-Expression: MIT
@@ -40,7 +40,12 @@ fivetran connector-metadata get google_ads
 fivetran public-connector list
 ```
 
-Output defaults to JSON. Use `--format table`, `--format yaml`, or `--output path` when needed.
+Output defaults to compact raw JSON for scripting. Use `--pretty` for readable output. Pretty output renders list responses as compact item blocks and detail responses as key/value sections.
+
+```bash
+fivetran connection list --pretty
+fivetran connection get connection_id --pretty
+```
 
 Request body commands accept either raw JSON or a JSON file:
 
@@ -113,7 +118,7 @@ These API areas are still intentionally not implemented:
 - Group destination listing, pending confirmation of a supported REST endpoint
 - Interactive connector setup workflows
 - File upload/download handling for Connector SDK packages
-- High-quality resource-specific table formats beyond the generic table renderer
+- High-quality resource-specific pretty views beyond the generic renderer
 
 ## Build And Publish
 

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3}/README.md

@@ -24,7 +24,12 @@ fivetran connector-metadata get google_ads
 fivetran public-connector list
 ```
 
-Output defaults to JSON. Use `--format table`, `--format yaml`, or `--output path` when needed.
+Output defaults to compact raw JSON for scripting. Use `--pretty` for readable output. Pretty output renders list responses as compact item blocks and detail responses as key/value sections.
+
+```bash
+fivetran connection list --pretty
+fivetran connection get connection_id --pretty
+```
 
 Request body commands accept either raw JSON or a JSON file:
 
@@ -97,7 +102,7 @@ These API areas are still intentionally not implemented:
 - Group destination listing, pending confirmation of a supported REST endpoint
 - Interactive connector setup workflows
 - File upload/download handling for Connector SDK packages
-- High-quality resource-specific table formats beyond the generic table renderer
+- High-quality resource-specific pretty views beyond the generic renderer
 
 ## Build And Publish
 

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fivetran-cli"
-version = "0.1.1"
+version = "0.1.3"
 description = "Command line wrapper for the Fivetran REST API"
 readme = "README.md"
 requires-python = ">=3.11"

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3}/src/fivetran_cli/__init__.py

@@ -1,3 +1,3 @@
 """Fivetran CLI package."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3}/src/fivetran_cli/cli.py

@@ -20,10 +20,9 @@ GLOBAL_OPTIONS_WITH_VALUES = {
     "--api-key",
     "--profile",
     "--base-url",
-    "--format",
     "--output",
 }
-GLOBAL_FLAG_OPTIONS = {"--quiet", "--verbose"}
+GLOBAL_FLAG_OPTIONS = {"--pretty", "--quiet", "--verbose"}
 OPERATION_EPILOG = (
     "Credentials default to FIVETRAN_API_KEY, which should contain the Base64-encoded API key. "
     "FIVETRAN_BASE_URL overrides the default API base URL. "
@@ -75,12 +74,13 @@ def run(
         return 0
 
     try:
+        output_format = _output_format(args)
         config = resolve_config(args)
         client = client_factory(config)
         payload = args.handler(args, client)
         emit_output(
             payload,
-            output_format=args.format,
+            output_format=output_format,
             output_path=args.output,
             quiet=args.quiet,
             stdout=stdout,
@@ -129,17 +129,18 @@ def _add_global_options(parser: argparse.ArgumentParser) -> None:
         "--base-url",
         help="Fivetran API base URL. Defaults to FIVETRAN_BASE_URL or https://api.fivetran.com.",
     )
-    parser.add_argument(
-        "--format",
-        choices=("json", "table", "yaml"),
-        default="json",
-        help="Output format.",
-    )
+    parser.add_argument("--pretty", action="store_true", help="Render output as a readable summary.")
     parser.add_argument("--output", help="Write output to a path instead of stdout.")
     parser.add_argument("--quiet", action="store_true", help="Suppress response output.")
     parser.add_argument("--verbose", action="store_true", help="Enable verbose diagnostics.")
 
 
+def _output_format(args: argparse.Namespace) -> str:
+    if args.pretty:
+        return "pretty"
+    return "json"
+
+
 def _add_account(resources: argparse._SubParsersAction[argparse.ArgumentParser]) -> None:
     account = resources.add_parser(
         "account",

fivetran_cli-0.1.3/src/fivetran_cli/output.py

@@ -0,0 +1,201 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any, TextIO
+
+from .client import CliError
+
+
+def emit_output(
+    payload: Any,
+    *,
+    output_format: str,
+    output_path: str | None,
+    quiet: bool,
+    stdout: TextIO,
+) -> None:
+    if quiet or payload is None:
+        return
+    rendered = render(payload, output_format)
+    if output_path:
+        try:
+            Path(output_path).write_text(rendered + "\n", encoding="utf-8")
+        except OSError as exc:
+            raise CliError(f"Could not write output file {output_path}: {exc}") from exc
+        return
+    stdout.write(rendered + "\n")
+
+
+def render(payload: Any, output_format: str) -> str:
+    if output_format == "json":
+        return json.dumps(payload, separators=(",", ":"))
+    if output_format == "pretty":
+        return _to_pretty(payload)
+    raise ValueError(f"Unsupported output format: {output_format}")
+
+
+def _to_pretty(payload: Any) -> str:
+    if isinstance(payload, dict) and "data" in payload:
+        lines: list[str] = []
+        code = payload.get("code")
+        message = payload.get("message")
+        if code and code != "Success":
+            lines.append(f"code: {code}")
+        if message:
+            lines.append(f"message: {message}")
+
+        rendered = _pretty_value(payload["data"])
+        if rendered:
+            if lines:
+                lines.append("")
+            lines.append(rendered)
+        return "\n".join(lines)
+    return _pretty_value(payload)
+
+
+def _pretty_value(value: Any) -> str:
+    if isinstance(value, dict):
+        if isinstance(value.get("items"), list):
+            return _pretty_items(value["items"], next_cursor=value.get("next_cursor"))
+        return _pretty_object(value)
+    if isinstance(value, list):
+        return _pretty_items(value)
+    return _cell(value)
+
+
+def _pretty_items(items: list[Any], *, next_cursor: Any = None) -> str:
+    count_label = f"{len(items)} item" if len(items) == 1 else f"{len(items)} items"
+    if not items:
+        lines = [count_label]
+        if next_cursor:
+            lines.append(f"next_cursor: {next_cursor}")
+        return "\n".join(lines)
+
+    if all(isinstance(item, dict) for item in items):
+        rendered_items = _pretty_item_blocks(items)
+    else:
+        rendered_items = "\n".join(f"- {_cell(item)}" for item in items)
+
+    lines = [count_label, "", rendered_items]
+    if next_cursor:
+        lines.extend(["", f"next_cursor: {next_cursor}"])
+    return "\n".join(lines)
+
+
+def _pretty_object(value: dict[str, Any], *, indent: int = 0) -> str:
+    prefix = " " * indent
+    lines: list[str] = []
+    nested: list[tuple[str, Any]] = []
+
+    for key, item in value.items():
+        if _is_scalar(item):
+            lines.append(f"{prefix}{key}: {_pretty_cell(key, item)}")
+        else:
+            nested.append((key, item))
+
+    for key, item in nested:
+        if lines:
+            lines.append("")
+        lines.append(f"{prefix}{key}:")
+        rendered = _pretty_value(item)
+        if rendered:
+            lines.append(_indent(rendered, indent + 2))
+
+    return "\n".join(lines)
+
+
+def _pretty_item_blocks(rows: list[dict[str, Any]]) -> str:
+    blocks: list[str] = []
+    for index, row in enumerate(rows, start=1):
+        flattened = _flatten_scalars(row)
+        label = _item_label(flattened, index)
+        lines = [label]
+        for key in _pretty_keys(flattened):
+            if key == label.key:
+                continue
+            lines.append(f"  {key}: {_cell(flattened[key])}")
+        blocks.append("\n".join(lines))
+    return "\n\n".join(blocks)
+
+
+def _flatten_scalars(row: dict[str, Any], *, prefix: str = "", depth: int = 0) -> dict[str, Any]:
+    flattened: dict[str, Any] = {}
+    for key, value in row.items():
+        column = f"{prefix}.{key}" if prefix else str(key)
+        if _is_scalar(value):
+            flattened[column] = _redact_if_sensitive(column, value)
+        elif isinstance(value, dict) and depth < 1:
+            flattened.update(_flatten_scalars(value, prefix=column, depth=depth + 1))
+    return flattened
+
+
+class _ItemLabel(str):
+    key: str | None
+
+    def __new__(cls, value: str, key: str | None = None) -> "_ItemLabel":
+        obj = str.__new__(cls, value)
+        obj.key = key
+        return obj
+
+
+def _item_label(row: dict[str, Any], index: int) -> _ItemLabel:
+    for key in ("id", "name", "service"):
+        value = row.get(key)
+        if value:
+            return _ItemLabel(str(value), key)
+    return _ItemLabel(f"item {index}", None)
+
+
+def _pretty_keys(rows: dict[str, Any]) -> list[str]:
+    preferred = [
+        "id",
+        "name",
+        "service",
+        "schema",
+        "group_id",
+        "paused",
+        "status.sync_state",
+        "status.setup_state",
+        "sync_state",
+        "setup_state",
+        "created_at",
+        "updated_at",
+    ]
+    available = set(rows)
+    ordered = [column for column in preferred if column in available]
+    ordered.extend(sorted(available - set(ordered)))
+    return ordered
+
+
+def _is_scalar(value: Any) -> bool:
+    return value is None or isinstance(value, (str, int, float, bool))
+
+
+def _pretty_cell(key: str, value: Any) -> str:
+    return _cell(_redact_if_sensitive(key, value))
+
+
+def _redact_if_sensitive(key: str, value: Any) -> Any:
+    if value is not None and _is_sensitive_name(key):
+        return "[redacted]"
+    return value
+
+
+def _is_sensitive_name(key: str) -> bool:
+    normalized = key.lower().replace("-", "_")
+    sensitive_parts = ("password", "secret", "token", "api_key", "private_key")
+    return any(part in normalized for part in sensitive_parts)
+
+
+def _indent(text: str, spaces: int) -> str:
+    prefix = " " * spaces
+    return "\n".join(f"{prefix}{line}" if line else "" for line in text.splitlines())
+
+
+def _cell(value: Any) -> str:
+    if value is None:
+        return ""
+    if isinstance(value, (dict, list)):
+        return json.dumps(value, sort_keys=True)
+    return str(value)

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3/src/fivetran_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fivetran-cli
-Version: 0.1.1
+Version: 0.1.3
 Summary: Command line wrapper for the Fivetran REST API
 Author: Fivetran
 License-Expression: MIT
@@ -40,7 +40,12 @@ fivetran connector-metadata get google_ads
 fivetran public-connector list
 ```
 
-Output defaults to JSON. Use `--format table`, `--format yaml`, or `--output path` when needed.
+Output defaults to compact raw JSON for scripting. Use `--pretty` for readable output. Pretty output renders list responses as compact item blocks and detail responses as key/value sections.
+
+```bash
+fivetran connection list --pretty
+fivetran connection get connection_id --pretty
+```
 
 Request body commands accept either raw JSON or a JSON file:
 
@@ -113,7 +118,7 @@ These API areas are still intentionally not implemented:
 - Group destination listing, pending confirmation of a supported REST endpoint
 - Interactive connector setup workflows
 - File upload/download handling for Connector SDK packages
-- High-quality resource-specific table formats beyond the generic table renderer
+- High-quality resource-specific pretty views beyond the generic renderer
 
 ## Build And Publish
 

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3}/src/fivetran_cli.egg-info/SOURCES.txt

@@ -13,4 +13,5 @@ src/fivetran_cli.egg-info/dependency_links.txt
 src/fivetran_cli.egg-info/entry_points.txt
 src/fivetran_cli.egg-info/top_level.txt
 tests/test_cli.py
-tests/test_client.py
+tests/test_client.py
+tests/test_output.py

{fivetran_cli-0.1.1 → fivetran_cli-0.1.3}/tests/test_cli.py

@@ -101,6 +101,14 @@ class CliTests(unittest.TestCase):
             {"group_id": "group", "service": "github", "config": {}},
         )
 
+    def test_default_output_is_compact_json(self):
+        code, stdout, stderr, _ = self.run_cli(
+            ["--api-key", "key", "account", "get"]
+        )
+
+        self.assertEqual(code, 0, stderr)
+        self.assertEqual(stdout, '{"data":{"ok":true}}\n')
+
     def test_global_options_work_after_resource_command(self):
         code, stdout, stderr, client = self.run_cli(
             [
@@ -109,8 +117,6 @@ class CliTests(unittest.TestCase):
                 "connection_id",
                 "--api-key",
                 "key",
-                "--format",
-                "table",
             ]
         )
 
@@ -118,6 +124,24 @@ class CliTests(unittest.TestCase):
         self.assertEqual(client.calls[0][0:2], ("GET", "/v1/connections/connection_id"))
         self.assertIn("ok", stdout)
 
+    def test_pretty_option_works_after_resource_command(self):
+        code, stdout, stderr, client = self.run_cli(
+            [
+                "connection",
+                "list",
+                "--all",
+                "--api-key",
+                "key",
+                "--pretty",
+            ]
+        )
+
+        self.assertEqual(code, 0, stderr)
+        self.assertEqual(client.calls[0][0:2], ("GET", "/v1/connections"))
+        self.assertIn("2 items", stdout)
+        self.assertIn("one", stdout)
+        self.assertIn("two", stdout)
+
     def test_delete_requires_yes_in_noninteractive_mode(self):
         code, _, stderr, client = self.run_cli(
             [

fivetran_cli-0.1.3/tests/test_output.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import unittest
+
+from fivetran_cli.output import render
+
+
+class OutputTests(unittest.TestCase):
+    def test_pretty_render_flattens_list_items_to_blocks(self):
+        payload = {
+            "code": "Success",
+            "data": {
+                "items": [
+                    {
+                        "id": "conn_1",
+                        "service": "postgres",
+                        "status": {"sync_state": "scheduled", "setup_state": "connected"},
+                        "config": {"password": "hidden"},
+                    },
+                    {
+                        "id": "conn_2",
+                        "service": "github",
+                        "status": {"sync_state": "paused", "setup_state": "connected"},
+                        "config": {"password": "hidden"},
+                    },
+                ],
+                "next_cursor": "next",
+            },
+        }
+
+        rendered = render(payload, "pretty")
+
+        self.assertIn("2 items", rendered)
+        self.assertIn("conn_1", rendered)
+        self.assertIn("conn_2", rendered)
+        self.assertIn("service: postgres", rendered)
+        self.assertIn("status.sync_state", rendered)
+        self.assertIn("scheduled", rendered)
+        self.assertIn("next_cursor: next", rendered)
+        self.assertNotIn("hidden", rendered)
+        self.assertNotIn("------", rendered)
+
+    def test_pretty_render_formats_detail_objects(self):
+        payload = {
+            "data": {
+                "id": "conn_1",
+                "service": "postgres",
+                "status": {"sync_state": "scheduled"},
+            }
+        }
+
+        rendered = render(payload, "pretty")
+
+        self.assertIn("id: conn_1", rendered)
+        self.assertIn("service: postgres", rendered)
+        self.assertIn("status:", rendered)
+        self.assertIn("sync_state: scheduled", rendered)
+
+
+if __name__ == "__main__":
+    unittest.main()

fivetran_cli-0.1.1/src/fivetran_cli/output.py

@@ -1,121 +0,0 @@
-from __future__ import annotations
-
-import json
-from pathlib import Path
-from typing import Any, TextIO
-
-from .client import CliError
-
-
-def emit_output(
-    payload: Any,
-    *,
-    output_format: str,
-    output_path: str | None,
-    quiet: bool,
-    stdout: TextIO,
-) -> None:
-    if quiet or payload is None:
-        return
-    rendered = render(payload, output_format)
-    if output_path:
-        try:
-            Path(output_path).write_text(rendered + "\n", encoding="utf-8")
-        except OSError as exc:
-            raise CliError(f"Could not write output file {output_path}: {exc}") from exc
-        return
-    stdout.write(rendered + "\n")
-
-
-def render(payload: Any, output_format: str) -> str:
-    if output_format == "json":
-        return json.dumps(payload, indent=2, sort_keys=True)
-    if output_format == "yaml":
-        return _to_yaml(payload)
-    if output_format == "table":
-        return _to_table(payload)
-    raise ValueError(f"Unsupported output format: {output_format}")
-
-
-def _to_yaml(value: Any, indent: int = 0) -> str:
-    prefix = " " * indent
-    if isinstance(value, dict):
-        lines: list[str] = []
-        for key, item in value.items():
-            if isinstance(item, (dict, list)):
-                lines.append(f"{prefix}{key}:")
-                lines.append(_to_yaml(item, indent + 2))
-            else:
-                lines.append(f"{prefix}{key}: {_yaml_scalar(item)}")
-        return "\n".join(lines)
-    if isinstance(value, list):
-        lines = []
-        for item in value:
-            if isinstance(item, (dict, list)):
-                lines.append(f"{prefix}-")
-                lines.append(_to_yaml(item, indent + 2))
-            else:
-                lines.append(f"{prefix}- {_yaml_scalar(item)}")
-        return "\n".join(lines)
-    return f"{prefix}{_yaml_scalar(value)}"
-
-
-def _yaml_scalar(value: Any) -> str:
-    if value is None:
-        return "null"
-    if isinstance(value, bool):
-        return "true" if value else "false"
-    if isinstance(value, (int, float)):
-        return str(value)
-    return json.dumps(str(value))
-
-
-def _to_table(payload: Any) -> str:
-    rows = _table_rows(payload)
-    if not rows:
-        return ""
-    if not all(isinstance(row, dict) for row in rows):
-        return json.dumps(payload, indent=2, sort_keys=True)
-
-    columns = _columns(rows)
-    widths = {
-        column: max(len(column), *(len(_cell(row.get(column))) for row in rows))
-        for column in columns
-    }
-    header = "  ".join(column.ljust(widths[column]) for column in columns)
-    separator = "  ".join("-" * widths[column] for column in columns)
-    body = [
-        "  ".join(_cell(row.get(column)).ljust(widths[column]) for column in columns)
-        for row in rows
-    ]
-    return "\n".join([header, separator, *body])
-
-
-def _table_rows(payload: Any) -> list[Any]:
-    if isinstance(payload, dict):
-        data = payload.get("data")
-        if isinstance(data, dict) and isinstance(data.get("items"), list):
-            return data["items"]
-        if isinstance(data, list):
-            return data
-        if isinstance(data, dict):
-            return [data]
-    if isinstance(payload, list):
-        return payload
-    return []
-
-
-def _columns(rows: list[dict[str, Any]]) -> list[str]:
-    preferred = ["id", "name", "service", "schema", "group_id", "created_at"]
-    available = {key for row in rows for key in row}
-    ordered = [column for column in preferred if column in available]
-    ordered.extend(sorted(available - set(ordered)))
-    return ordered
-
-
-def _cell(value: Any) -> str:
-    if value is None:
-        return ""
-    if isinstance(value, (dict, list)):
-        return json.dumps(value, sort_keys=True)
-    return str(value)