perspective-cli 0.1.0__py3-none-any.whl

perspective/utils/options.py

@@ -0,0 +1,77 @@
+"""Common Typer options."""
+
+import os
+from pathlib import Path
+from typing import Annotated
+
+import typer
+
+
+MetadataDir: Path = typer.Option(
+    Path(os.getenv("DBT_PROFILES_DIR", ".")) / "target",
+    "--metadata-dir",
+    "-m",
+    help="Specify the directory with dbt metadata files. Defaults to $DBT_PROFILES_DIR/target or ./target if not set.",
+    exists=True,
+    dir_okay=True,
+    resolve_path=True,
+)
+
+ConfigDir: Path = typer.Option(
+    "./.perspective",
+    "--config-dir",
+    "-c",
+    help="Specify the directory with the config files. Defaults to ./.perspective",
+    envvar="PERSPECTIVE_CONFIG_DIR",
+    dir_okay=True,
+    resolve_path=True,
+)
+
+Force: bool = typer.Option(
+    False,
+    "--force",
+    "-f",
+    help="Force the operation.",
+)
+
+DryRun: bool = typer.Option(
+    False,
+    "--dry-run",
+    "-D",
+    help="Perform a dry run. Print the payload but do not send it.",
+)
+
+NoConfig: bool = typer.Option(
+    False,
+    "--no-config",
+    "-n",
+    help="Set this flag to prevent sending configuration data along with the request.",
+)
+
+Follow: bool = typer.Option(
+    False, "--follow", help="Follow the ingestion process until it's completed."
+)
+
+IngestionId = Annotated[str, typer.Argument(help="Ingestion ID.")]
+
+PerspectiveURL: str = typer.Option(
+    "http://localhost:8000/api/v1/",
+    "--url",
+    "-u",
+    help="URL of the Perspective API.",
+    envvar="PERSPECTIVE_API_URL",
+)
+
+FollowTimeout: int = typer.Option(
+    30,
+    "--follow-timeout",
+    "-t",
+    help="How many seconds to wait for the ingestion process to complete.",
+    envvar="PERSPECTIVE_TIMEOUT",
+)
+
+IsDbtTestResultsIngestion: bool = typer.Option(
+    False,
+    "--test-results",
+    help="Set this flag to only ingest dbt test results.",
+)

perspective/utils/utils.py

@@ -0,0 +1,274 @@
+"""Utility functions."""
+
+from enum import Enum
+import json
+from pathlib import Path
+import subprocess  # noqa: S404
+from traceback import format_exc
+from urllib.parse import urljoin
+
+from requests import Response, request
+from requests.exceptions import ConnectionError as RequestsConnectionError
+from requests.exceptions import Timeout
+from rich import print as rprint
+from rich.console import Console
+from rich.panel import Panel
+import typer
+
+
+console = Console()
+
+
+class IngestionStatus(Enum):
+    """Ingestion status values."""
+
+    successful = 0
+    failed = 1
+    pending = 2
+
+
+class HttpMethod(str, Enum):
+    """HTTP methods."""
+
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    DELETE = "DELETE"
+    HEAD = "HEAD"
+    OPTIONS = "OPTIONS"
+    PATCH = "PATCH"
+
+
+def safe_json_load(path: str | Path) -> dict | None:
+    """Reads a JSON file into a Python dictionary.
+
+    Args:
+        path (str | Path): The path to the JSON file.
+
+    Returns:
+        dict | None: A dictionary representation of the JSON file, or None if an error
+            occurs.
+    """
+    try:
+        with Path(path).open("r", encoding="utf-8") as f:
+            data = json.load(f)
+    except Exception:
+        data = None
+    return data
+
+
+def run_command(command: str, capture_output: bool = False) -> str | None:
+    """Execute a shell command and optionally capture its output.
+
+    Args:
+        command (str): The shell command to be executed.
+        capture_output (bool, optional): Flag to determine if the command's output
+            should be captured. Defaults to False.
+
+    Returns:
+        str | None: The standard output of the command if `capture_output` is True,
+            otherwise None.
+
+    Raises:
+        typer.Exit: Exits the script if the command execution fails.
+    """
+    try:
+        result = subprocess.run(  # noqa: S602
+            command,
+            shell=True,
+            check=True,
+            capture_output=True,
+            text=True,
+        )
+    except subprocess.CalledProcessError as e:
+        console.print(
+            Panel.fit(
+                f"[bold red]ERROR[/bold red]: An error occurred while running the command: [bold yellow]{e}[/bold yellow]",
+                title="Error",
+                border_style="red",
+            )
+        )
+        if e.output:
+            console.print(f"[bold cyan]Output[/bold cyan]: {e.output}")
+        if e.stderr:
+            console.print(f"[bold red]Error[/bold red]: {e.stderr}")
+        raise typer.Exit(1) from e
+
+    if capture_output:
+        return result.stdout.strip()
+
+    return None
+
+
+def print_response(response: Response) -> None:
+    """Print an API response.
+
+    Args:
+        response (requests.Response): The response to print.
+    """
+    try:
+        parsed_response = response.json()
+    except Exception:
+        parsed_response = None
+
+    if response.ok:
+        msg = "[green]The request was successful.[/green]"
+        if parsed_response:
+            msg += f"\n[yellow]Response:\n{parsed_response}[/yellow]"
+        else:
+            msg += f"\n[green]Raw response:\n{response.text}[/green]"
+    else:
+        if parsed_response:
+            error_msg = f"\n\nError message: {parsed_response['message']}"
+        else:
+            error_msg = f"Raw response:\n{response.text}"
+        msg = f"[red]The request failed with status code {response.status_code}.{error_msg}[/red]"
+
+    rprint(msg)
+
+    if not response.ok or parsed_response is None:
+        raise typer.Exit(1)
+
+
+def send_request(
+    url: str,
+    payload: dict | list | None = None,
+    verify: bool = True,
+    method: HttpMethod = HttpMethod.POST,
+    timeout: (float | tuple[float, float] | tuple[float, None]) = (21.05, 60 * 30),
+    headers: dict[str, str] | None = None,
+    params: dict[str, str | int | float] | None = None,
+    return_response_key: str | None = None,
+) -> Response | tuple[Response, str | None]:
+    """Send an HTTP request.
+
+    Args:
+        url (str): The URL for the request.
+        payload (dict | list | None): The payload for the request, if any.
+        verify (bool, optional): Whether to verify the server's TLS certificate.
+            Defaults to True.
+        method (HttpMethod, optional): _description_. Defaults to HttpMethod.POST.
+        timeout (optional[float | tuple[float, float] | tuple[float, None]]): The
+            timeout for the request. Defaults to (20, 60 * 30).
+        headers (optional[dict[str, str]], optional): Headers to be sent with the
+            request. Defaults to None.
+        params (optional[dict[str, str | int | float]]): URL parameters for the request.
+            Defaults to None.
+        return_response_key (str | None, optional): Key to extract from the response.
+            Defaults to None.
+
+    Raises:
+        typer.Exit: In case of timeout or connection error.
+
+    Returns:
+        [requests.Response | tuple[requests.Response, str | None]]: The HTTP response
+            and a value extracted from the response (if `return_response_key` is
+            provided).
+    """
+    rprint("[yellow]Sending request to Perspective...[/yellow]")
+
+    try:
+        response = request(
+            method=method,
+            url=url,
+            headers=headers,
+            params=params,
+            json=payload,
+            verify=verify,
+            timeout=timeout,
+        )
+    except (Timeout, RequestsConnectionError) as e:
+        error_message = (
+            "The request has failed. Please check your connection and try again."
+        )
+        if isinstance(e, Timeout):
+            error_message += " If you're using a VPN, ensure it's properly connected or try disabling it temporarily."
+        else:
+            error_message += " This could be due to maximum retries being exceeded or failure to establish a new connection. Please check your network configuration."
+
+        rprint(Panel(f"[red]{error_message}[/red]"))
+
+        # Print the traceback
+        traceback_info = format_exc()
+        rprint(Panel(f"[red]{traceback_info}[/red]"))
+
+        raise typer.Exit(1) from e
+
+    if not response.ok:
+        rprint(
+            Panel(
+                f"[red]The request to {url} FAILED with status: {response.status_code} ({response.reason})[/red]"
+            )
+        )
+        raise typer.Exit(1)
+
+    print_response(response)
+
+    if return_response_key:
+        extracted_value = response.json().get(return_response_key)
+        return response, extracted_value
+    return response
+
+
+def check_ingestion_status(
+    perspective_url: str, ingestion_uuid: str, verify: bool = True
+) -> str:
+    """Fetches the status for a specific ingestion ID from Perspective.
+
+    Args:
+        perspective_url (str): The URL of the Perspective instance.
+        ingestion_uuid (str): The ingestion ID to fetch the status for.
+        verify (bool): Whether to verify the server's TLS certificate. Defaults to True.
+
+    Returns:
+        str: The status of the ingestion process.
+    """
+    status_endpoint = urljoin(perspective_url, "catalog/ingestions/")
+    response = send_request(
+        method="GET",
+        url=status_endpoint,
+        params={"uuid": ingestion_uuid},
+        verify=verify,
+    )
+    ingestion = response.json().get("data")
+    return ingestion.get("status")
+
+
+def check_ingestion_results(
+    perspective_url: str, ingestion_uuid: str, verify: bool = True
+) -> str | dict:
+    """Fetche and interpret the results for a specific ingestion ID.
+
+    Args:
+        perspective_url (str): The URL of the Perspective instance.
+        ingestion_uuid (str): The ingestion ID to check the results for.
+        verify (bool): Whether to verify the server's TLS certificate. Defaults to True.
+
+    Returns:
+        str | dict: A message describing the status of the ingestion process or
+            the JSON response for successful completions.
+    """
+    status_endpoint = urljoin(perspective_url, "catalog/ingestions/")
+    response = send_request(
+        method="GET",
+        url=status_endpoint,
+        params={"uuid": ingestion_uuid},
+        verify=verify,
+    )
+    ingestion = response.json().get("data")
+    status = ingestion.get("status")
+
+    if status == IngestionStatus.pending.value:
+        return f"Ingestion ID {ingestion_uuid} is still pending."
+
+    if status == IngestionStatus.failed.value:
+        error_details = ingestion.get("error", "No additional error details provided.")
+        return (
+            f"Ingestion ID {ingestion_uuid} has failed. Error details: {error_details}"
+        )
+
+    if status == IngestionStatus.successful.value:
+        # Return the entire JSON response for successful completions
+        return ingestion.get("summary")
+
+    return f"Unrecognized status for ingestion ID {ingestion_uuid}: {status}"

perspective_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: perspective-cli
+Version: 0.1.0
+Summary: A CLI tool for managing the Perspective AI platform.
+Author-email: Michal Zawadzki <mzawadzki@dyvenia.com>
+Keywords: cli,dbt,perspective,data,catalog,ai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: typer[all]<1.0,>=0.9
+Requires-Dist: psycopg[binary]>=3.2.3
+Requires-Dist: requests<3.0,>=2.20
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: rich<13.8,>=13.7
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: websocket-client>=1.8.0
+Requires-Dist: requests-ntlm>=1.3.0
+Requires-Dist: websockets>=10.4
+Requires-Dist: pydantic[email]==2.11.7
+Requires-Dist: azure-identity>=1.17.1
+Requires-Dist: dlt[duckdb]>=1.11.0
+Requires-Dist: duckdb>1.1.3
+Requires-Dist: dbt-artifacts-parser<1.0,>=0.12.0
+Provides-Extra: sap
+Requires-Dist: pyrfc==2.5.0; extra == "sap"
+
+# perspective-cli
+
+## Installation
+
+### `pip`
+
+```bash
+pip install perspective-cli
+```
+
+### `uv`
+
+```bash
+uv add perspective-cli
+```
+
+## Next Steps
+
+Proceed to the [official documentation](dev.meetperspective.com/docs/catalog/) for next steps and detailed guides on how to utilize `perspective-cli` effectively.

perspective_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+perspective/__init__.py,sha256=RMqGNAtJDIHYnlTfMKR_Zljb9KV_ZAT714yhQ1jdRFM,23
+perspective/config.py,sha256=0oBT522vbSLxyyGiJLTf5Qrhx8Yi5DbwPZwnT2ZBo4Q,7595
+perspective/exceptions.py,sha256=awwIcnVIAqXPX5W8eMM0zREW8FJOdlqj29mJ7lkDNM0,426
+perspective/main.py,sha256=1muq6dEnJt0h5loUxCPCNpkEfAiajTaSSOwcwEIo9gU,1765
+perspective/ingest/dbt.py,sha256=Bn-vMJnOicENd5jAYr-tRjtJ9jWdUo6Ddu49gV-cA3c,5188
+perspective/ingest/ingest.py,sha256=3n7ffsQBnskOoRhvHK5Iy06dlvKbDVrt5mIIPRplhfk,5034
+perspective/ingest/postgres.py,sha256=m9QStEBbgSsEBmn7gEJQ5-Oc1ydstj3rG_lF1Xiu908,12248
+perspective/ingest/sources/bi/powerbi/extract.py,sha256=m8eLA9fY7UT4xbdge0s8i1kXM3hjuj67XWaGNuWl2qo,6705
+perspective/ingest/sources/bi/powerbi/models.py,sha256=v3Gcd0SjHvYif91ACUeCIpLz3_KUOFHyAKcq7zdS41A,2854
+perspective/ingest/sources/bi/powerbi/pipeline.py,sha256=46lCTKAXtrcemIMfeG_1ul97jnetgSOcnyTjSvYwbbk,1002
+perspective/ingest/sources/bi/powerbi/transform.py,sha256=kytJakFbCjZWz_qfG8_pGbRptvv3PetmbB2W-8FZCoI,17817
+perspective/ingest/sources/bi/qlik_sense/extract.py,sha256=2FvQ9HGJZO1gMkBIFvBTOld4N9AXLfKjczIeakS5qls,10676
+perspective/ingest/sources/bi/qlik_sense/models.py,sha256=dxhjAFzWhkx5vG3MQWhu0oaQAU9BlPTx89vmWiFpvb8,412
+perspective/ingest/sources/bi/qlik_sense/pipeline.py,sha256=fa_aClpLbeOnh-z0YlO9rs8bvo0rqzrOjQ8N7UDedNw,522
+perspective/ingest/sources/bi/qlik_sense/transform.py,sha256=oU8NbJUrnAZjSX1Vej1aRknm82FIc8eac60F9IfrHMw,2392
+perspective/ingest/sources/database/sap/extract.py,sha256=oQGoB-I_fxa4Mbs3Fk-PTF65NwYZg9vr3l2-XwBGa1U,9063
+perspective/ingest/sources/database/sap/pipeline.py,sha256=w-ExBhMAcXuySdEFs_1Z3pNBxmAGfrU_FYM15wo8F5A,810
+perspective/ingest/sources/database/sap/transform.py,sha256=4KCurK-NrlPCqK4Wv52eSfTkSBN3lWlf_9cGqB_0kao,2745
+perspective/models/configs.py,sha256=t5GJ0QORG6wlKyF2saGJyzE3H9E6psDXJ_6UwsDFSTw,9420
+perspective/models/dashboards.py,sha256=8wcg-YfymPP_ErSbjvUgKWPju2PktjvZMShdmkL6APU,1084
+perspective/models/databases.py,sha256=XLDZ29hLhrCVUMmnbodv1quNcuRcLeexiR_tZkxnCeM,536
+perspective/utils/__init__.py,sha256=8PP1VNUc3DkZBgadUEvImVpuYUrAigkD7aYRCmSZ1l4,85
+perspective/utils/options.py,sha256=a8eVilistizMOxFFOPpW8TKNvi5kaZoxUw67nzFbs8w,1751
+perspective/utils/utils.py,sha256=CWUsV8Zp9dZJEiKSS1Hbu_Gxf6B_kCMT_NWlQ6L3jrU,8760
+perspective_cli-0.1.0.dist-info/METADATA,sha256=TiO7EaOAWV3Qt2mZGUFpe1A6J2ep5Aha3bMQQombYho,1398
+perspective_cli-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+perspective_cli-0.1.0.dist-info/entry_points.txt,sha256=FyAeBznbZy1x_I_ZMg3pB7TPOJ1oZRT3RHKho7Mr7mk,53
+perspective_cli-0.1.0.dist-info/top_level.txt,sha256=-W1-t6tcSPy7mH-EhKzt_SJAICr8eZmyBwC3Eu5kqkU,12
+perspective_cli-0.1.0.dist-info/RECORD,,

perspective_cli-0.1.0.dist-info/WHEEL

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

perspective_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+perspective = perspective.main:app

perspective_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+perspective