fivetran-cli 0.1.0__py3-none-any.whl

fivetran_cli/client.py

@@ -0,0 +1,159 @@
+from __future__ import annotations
+
+import base64
+import json
+import urllib.error
+import urllib.parse
+import urllib.request
+from dataclasses import dataclass
+from typing import Any
+
+
+DEFAULT_BASE_URL = "https://api.fivetran.com"
+
+
+class CliError(Exception):
+    """User-facing CLI error."""
+
+
+@dataclass(frozen=True)
+class ClientConfig:
+    api_key: str | None
+    api_secret: str | None
+    base_url: str = DEFAULT_BASE_URL
+    verbose: bool = False
+
+
+class FivetranClient:
+    def __init__(self, config: ClientConfig) -> None:
+        self.config = config
+        self.base_url = config.base_url.rstrip("/")
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        *,
+        query: dict[str, Any] | None = None,
+        body: Any = None,
+        auth_required: bool = True,
+    ) -> Any:
+        if auth_required and (not self.config.api_key or not self.config.api_secret):
+            raise CliError(
+                "Missing Fivetran API credentials. Set FIVETRAN_API_KEY and "
+                "FIVETRAN_API_SECRET, pass --api-key/--api-secret, or use --profile."
+            )
+
+        url = self._url(path, query)
+        data: bytes | None = None
+        headers = {"Accept": "application/json"}
+        if body is not None:
+            data = json.dumps(body, separators=(",", ":")).encode("utf-8")
+            headers["Content-Type"] = "application/json"
+
+        if auth_required:
+            token = f"{self.config.api_key}:{self.config.api_secret}".encode("utf-8")
+            headers["Authorization"] = "Basic " + base64.b64encode(token).decode("ascii")
+
+        request = urllib.request.Request(url, data=data, headers=headers, method=method)
+
+        try:
+            with urllib.request.urlopen(request) as response:
+                raw = response.read()
+                return _decode_response(raw)
+        except urllib.error.HTTPError as exc:
+            raw = exc.read()
+            payload = _decode_response(raw)
+            message = _error_message(exc.code, payload, raw)
+            raise CliError(message) from exc
+        except urllib.error.URLError as exc:
+            raise CliError(f"Request failed: {exc.reason}") from exc
+
+    def paginated_request(
+        self,
+        method: str,
+        path: str,
+        *,
+        query: dict[str, Any] | None = None,
+        auth_required: bool = True,
+    ) -> Any:
+        merged: Any | None = None
+        cursor = query.get("cursor") if query else None
+
+        while True:
+            page_query = dict(query or {})
+            if cursor:
+                page_query["cursor"] = cursor
+            page = self.request(
+                method,
+                path,
+                query=page_query,
+                auth_required=auth_required,
+            )
+            merged = _merge_page(merged, page)
+            cursor = _next_cursor(page)
+            if not cursor:
+                return merged
+
+    def _url(self, path: str, query: dict[str, Any] | None) -> str:
+        clean_query = {
+            key: value
+            for key, value in (query or {}).items()
+            if value is not None and value is not False
+        }
+        query_string = urllib.parse.urlencode(clean_query)
+        url = f"{self.base_url}{path}"
+        if query_string:
+            return f"{url}?{query_string}"
+        return url
+
+
+def _decode_response(raw: bytes) -> Any:
+    if not raw:
+        return None
+    text = raw.decode("utf-8")
+    try:
+        return json.loads(text)
+    except json.JSONDecodeError:
+        return text
+
+
+def _error_message(status: int, payload: Any, raw: bytes) -> str:
+    if isinstance(payload, dict):
+        message = payload.get("message") or payload.get("error")
+        code = payload.get("code")
+        if code and message:
+            return f"HTTP {status}: {code}: {message}"
+        if message:
+            return f"HTTP {status}: {message}"
+    if raw:
+        return f"HTTP {status}: {raw.decode('utf-8', errors='replace')}"
+    return f"HTTP {status}"
+
+
+def _merge_page(merged: Any | None, page: Any) -> Any:
+    if merged is None:
+        return page
+    if not isinstance(merged, dict) or not isinstance(page, dict):
+        return page
+
+    merged_data = merged.get("data")
+    page_data = page.get("data")
+    if isinstance(merged_data, dict) and isinstance(page_data, dict):
+        merged_items = merged_data.get("items")
+        page_items = page_data.get("items")
+        if isinstance(merged_items, list) and isinstance(page_items, list):
+            merged_items.extend(page_items)
+            merged_data["next_cursor"] = page_data.get("next_cursor")
+            return merged
+    return page
+
+
+def _next_cursor(page: Any) -> str | None:
+    if not isinstance(page, dict):
+        return None
+    data = page.get("data")
+    if isinstance(data, dict):
+        cursor = data.get("next_cursor")
+        return str(cursor) if cursor else None
+    return None

fivetran_cli/output.py

@@ -0,0 +1,121 @@
+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)

fivetran_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: fivetran-cli
+Version: 0.1.0
+Summary: Command line wrapper for the Fivetran REST API
+Author: Fivetran
+License-Expression: MIT
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# fivetran-cli
+
+Thin command line wrapper around the Fivetran REST API.
+
+```text
+fivetran [global-options] <resource> <operation> [arguments] [options]
+```
+
+Credentials default to `FIVETRAN_API_KEY` and `FIVETRAN_API_SECRET`.
+
+```bash
+fivetran --api-key "$FIVETRAN_API_KEY" --api-secret "$FIVETRAN_API_SECRET" connection list
+fivetran connection create --data-file connection.json
+```
+
+## Usage
+
+Global options may be placed before or after the resource command.
+
+```bash
+fivetran connection list --api-key "$FIVETRAN_API_KEY" --api-secret "$FIVETRAN_API_SECRET"
+fivetran connection-schema get connection_id
+fivetran connector-metadata get google_ads
+fivetran public-connector list
+```
+
+Output defaults to JSON. Use `--format table`, `--format yaml`, or `--output path` when needed.
+
+Request body commands accept either raw JSON or a JSON file:
+
+```bash
+fivetran private-link create --data-file private-link.json
+fivetran connection-schema column update connection_id schema table column --data '{"enabled":false}'
+```
+
+Destructive commands require `--yes` in non-interactive mode.
+
+## Included Commands
+
+Core resources:
+
+- `account get`
+- `connection list|get|create|update|delete|sync|resync|test`
+- `destination list|get|create|update|delete|test`
+- `group list|get|create|update|delete`
+- `group connection list`
+- `group user list|add|remove`
+- `group public-key get`
+- `group service-account get`
+
+Access management:
+
+- `user list|get|invite|update|delete`
+- `user account-role remove`
+- `user connection list|get|add|update|remove`
+- `user group list|get|add|update|remove`
+- `team list|get|create|update|delete`
+- `team account-role remove`
+- `team connection list|get|add|update|remove`
+- `team group list|get|add|update|remove`
+- `team user list|get|add|update|remove`
+- `role list`
+- `system-key list|get|create|update|delete|rotate`
+
+Schemas and metadata:
+
+- `connection-schema get|setup|update|reload|resync-table`
+- `connection-schema schema update`
+- `connection-schema table update`
+- `connection-schema column list|update|drop|drop-blocked`
+- `connector-metadata list|get`
+- `public-connector list`
+
+Networking:
+
+- `hybrid-deployment-agent list|get|create|delete|regenerate-auth|reset-credentials`
+- `proxy-agent list|get|create|delete|regenerate-secrets`
+- `proxy-agent connection list`
+- `private-link list|get|create|update|delete`
+
+Transformations:
+
+- `transformation list`
+
+## Not Included Yet
+
+These API areas are still intentionally not implemented:
+
+- Certificates and fingerprints
+- Connector SDK packages
+- Log services
+- Webhooks
+- Transformation create/get/update/delete/run/cancel/upgrade
+- Transformation package metadata
+- Transformation projects
+- Hub registration
+- 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
+
+## Build And Publish
+
+Package artifacts are controlled by `pyproject.toml` and `MANIFEST.in`. The source distribution intentionally excludes local agent/project-planning files:
+
+- `AGENTS.md`
+- `plans/`
+
+Install local packaging tools with `pipx`:
+
+```bash
+pipx install build
+pipx install twine
+```
+
+This exposes `pyproject-build` and `twine` on your PATH. If you install these tools into a virtual environment instead, use `python3 -m build` and `python3 -m twine` in place of the commands below.
+
+Build source and wheel distributions:
+
+```bash
+pyproject-build
+```
+
+Validate the generated artifacts:
+
+```bash
+twine check dist/*
+```
+
+Upload to TestPyPI first:
+
+```bash
+twine upload --repository testpypi dist/*
+```
+
+Install from TestPyPI in a clean environment:
+
+```bash
+python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ fivetran-cli
+fivetran --help
+```
+
+Upload to PyPI after the TestPyPI package is verified:
+
+```bash
+twine upload dist/*
+```
+
+These upload commands assume `~/.pypirc` is configured with the `pypi` and `testpypi` repositories. If `~/.pypirc` is not configured, set `TWINE_USERNAME=__token__` and `TWINE_PASSWORD=<api-token>` before running `twine upload`.
+
+PyPI files are immutable for a published version. If an upload is wrong, bump the version in `pyproject.toml`, rebuild, re-check, and upload the new version.

fivetran_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+fivetran_cli/__init__.py,sha256=MJaAT0U45TFotKU2sNcRFx8wISXJjqfTyhps30eYf6M,51
+fivetran_cli/__main__.py,sha256=PSQ4rpL0dG6f-qH4N7H-gD9igQkdHzH4yVZDcW8lfZo,80
+fivetran_cli/cli.py,sha256=DyY7m8oAvShfyJIcjzNu5re15mUavEmM8b96Viv9rQk,47548
+fivetran_cli/client.py,sha256=rY_zPh3B1-Yk7VRIbHXMAOm6n9wQhuazqGy68Q5v6hA,4910
+fivetran_cli/output.py,sha256=K6sPy79rbH5uGE9_RQ74YmNNhQ1O-0g0gTpbaxnqs1U,3725
+fivetran_cli-0.1.0.dist-info/licenses/LICENSE,sha256=8u5SmFMJwBaX9Qh0Nm9J6eZEkIb79gUyVAStZV1lPzk,1065
+fivetran_cli-0.1.0.dist-info/METADATA,sha256=ih1nUq67vMoYKVVpacSwJdjlYkbm6-CrUGccLJZfu1k,4838
+fivetran_cli-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+fivetran_cli-0.1.0.dist-info/entry_points.txt,sha256=vhb-xRrS8kxCBqOGS6DPnCDmSg3PK8QKB6BjbRFjVGI,51
+fivetran_cli-0.1.0.dist-info/top_level.txt,sha256=-B4QNe8Zpu58LFUDAxov_1XSrzKnQo07EleDwlCiYo8,13
+fivetran_cli-0.1.0.dist-info/RECORD,,

fivetran_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fivetran_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fivetran = fivetran_cli.cli:main

fivetran_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fivetran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fivetran_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fivetran_cli