tinybird 0.0.1.dev170__py3-none-any.whl → 0.0.1.dev171__py3-none-any.whl

tinybird/tb/__cli__.py

@@ -4,5 +4,5 @@ __description__ = 'Tinybird Command Line Tool'
 __url__ = 'https://www.tinybird.co/docs/forward/commands'
 __author__ = 'Tinybird'
 __author_email__ = 'support@tinybird.co'
-__version__ = '0.0.1.dev170'
-__revision__ = '0c715ac'
+__version__ = '0.0.1.dev171'
+__revision__ = 'a5eb91f'

tinybird/tb/modules/cli.py

@@ -71,6 +71,9 @@ VERSION = f"{__cli__.__version__} (rev {__cli__.__revision__})"
 @click.option("--show-tokens", is_flag=True, default=False, help="Enable the output of tokens.")
 @click.option("--cloud/--local", is_flag=True, default=False, help="Run against cloud or local.")
 @click.option("--staging", is_flag=True, default=False, help="Run against a staging deployment.")
+@click.option(
+    "--output", type=click.Choice(["json", "human"], case_sensitive=False), default="human", help="Output format"
+)
 @click.version_option(version=VERSION)
 @click.pass_context
 @coro
@@ -84,15 +87,19 @@ async def cli(
     show_tokens: bool,
     cloud: bool,
     staging: bool,
+    output: str,
 ) -> None:
     """
     Use `OBFUSCATE_REGEX_PATTERN` and `OBFUSCATE_PATTERN_SEPARATOR` environment variables to define a regex pattern and a separator (in case of a single string with multiple regex) to obfuscate secrets in the CLI output.
     """
     # We need to unpatch for our tests not to break
-    if show_tokens or not cloud or ctx.invoked_subcommand == "build":
-        __unpatch_click_output()
+    if output == "json":
+        __hide_click_output()
     else:
-        __patch_click_output()
+        if show_tokens or not cloud or ctx.invoked_subcommand == "build":
+            __unpatch_click_output()
+        else:
+            __patch_click_output()
 
     if getenv_bool("TB_DISABLE_SSL_CHECKS", False):
         click.echo(FeedbackManager.warning_disabled_ssl_checks())
@@ -167,6 +174,7 @@ async def cli(
 
     ctx.ensure_object(dict)["project"] = project
     ctx.ensure_object(dict)["env"] = get_target_env(cloud)
+    ctx.ensure_object(dict)["output"] = output
 
 
 @cli.command(hidden=True)
@@ -316,6 +324,24 @@ def __unpatch_click_output():
     click.secho = __old_click_secho
 
 
+def __hide_click_output() -> None:
+    """
+    Modify click.echo and click.secho to only output when explicitly requested.
+    Adds a 'force_output' parameter to both functions that defaults to False.
+    """
+
+    def silent_echo(msg: Any, *args: Any, force_output: bool = False, **kwargs: Any) -> None:
+        if force_output:
+            __old_click_echo(msg, *args, **kwargs)
+
+    def silent_secho(msg: Any, *args: Any, force_output: bool = False, **kwargs: Any) -> None:
+        if force_output:
+            __old_click_secho(msg, *args, **kwargs)
+
+    click.echo = silent_echo  # type: ignore
+    click.secho = silent_secho  # type: ignore
+
+
 async def create_ctx_client(ctx: Context, config: Dict[str, Any], cloud: bool, staging: bool):
     commands_without_ctx_client = [
         "auth",

tinybird/tb/modules/common.py

@@ -2227,3 +2227,7 @@ def get_error_event(error: str) -> Tuple[str, str]:
         error_event = "error"
         silent_error_msg = "Unknown error"
     return error_event, silent_error_msg
+
+
+def echo_json(data: Dict[str, Any]) -> None:
+    click.echo(json.dumps(data), force_output=True)  # type: ignore

tinybird/tb/modules/info.py

@@ -1,12 +1,12 @@
 import os
-from typing import Any, Dict, Iterable, List, Optional
+from typing import Any, Dict, Iterable, List, Optional, Tuple
 
 import click
 
 from tinybird.tb.client import TinyB
 from tinybird.tb.config import get_display_cloud_host
 from tinybird.tb.modules.cli import CLIConfig, cli
-from tinybird.tb.modules.common import coro, format_robust_table
+from tinybird.tb.modules.common import coro, echo_json, format_robust_table
 from tinybird.tb.modules.feedback_manager import FeedbackManager
 from tinybird.tb.modules.local_common import TB_LOCAL_ADDRESS, get_tinybird_local_config
 from tinybird.tb.modules.project import Project
@@ -19,15 +19,29 @@ async def info(ctx: click.Context) -> None:
     """Get information about the project that is currently being used"""
     ctx_config = ctx.ensure_object(dict)["config"]
     project: Project = ctx.ensure_object(dict)["project"]
+    is_json = ctx.ensure_object(dict)["output"] == "json"
     click.echo(FeedbackManager.highlight(message="» Tinybird Cloud:"))
-    await get_cloud_info(ctx_config)
+    cloud_table, cloud_columns = await get_cloud_info(ctx_config)
     click.echo(FeedbackManager.highlight(message="\n» Tinybird Local:"))
-    await get_local_info(ctx_config)
+    local_table, local_columns = await get_local_info(ctx_config)
     click.echo(FeedbackManager.highlight(message="\n» Project:"))
-    await get_project_info(project.folder)
+    project_table, project_columns = await get_project_info(project.folder)
+    if is_json:
+        cloud_data = {}
+        if cloud_columns and cloud_table and isinstance(cloud_table, list) and len(cloud_table) > 0:
+            cloud_data = {column: cloud_table[0][i] for i, column in enumerate(cloud_columns)}
 
+        local_data = {}
+        if local_columns and local_table and isinstance(local_table, list) and len(local_table) > 0:
+            local_data = {column: local_table[0][i] for i, column in enumerate(local_columns)}
 
-async def get_cloud_info(ctx_config: Dict[str, Any]) -> None:
+        project_data = {}
+        if project_columns and project_table and isinstance(project_table, list) and len(project_table) > 0:
+            project_data = {column: project_table[0][i] for i, column in enumerate(project_columns)}
+        echo_json({"cloud": cloud_data, "local": local_data, "project": project_data})
+
+
+async def get_cloud_info(ctx_config: Dict[str, Any]) -> Tuple[Iterable[Any], List[str]]:
     config = CLIConfig.get_project_config()
 
     try:
@@ -37,16 +51,17 @@ async def get_cloud_info(ctx_config: Dict[str, Any]) -> None:
         ui_host = get_display_cloud_host(api_host)
         user_email = config.get("user_email") or "No user email found"
         user_token = config.get_user_token() or "No user token found"
-        await get_env_info(client, ctx_config, user_email, token, user_token, api_host, ui_host)
+        return await get_env_info(client, ctx_config, user_email, token, user_token, api_host, ui_host)
     except Exception:
         click.echo(
             FeedbackManager.warning(
                 message="\n⚠  Could not retrieve Tinybird Cloud info. Please run `tb login` first or check that you are located in the correct directory."
             )
         )
+        return [], []
 
 
-async def get_local_info(config: Dict[str, Any]) -> None:
+async def get_local_info(config: Dict[str, Any]) -> Tuple[Iterable[Any], List[str]]:
     try:
         local_config = await get_tinybird_local_config(config, test=False, silent=False)
         local_client = local_config.get_client(host=TB_LOCAL_ADDRESS, staging=False)
@@ -55,19 +70,19 @@ async def get_local_info(config: Dict[str, Any]) -> None:
         user_token = local_config.get_user_token() or "No user token found"
         api_host = TB_LOCAL_ADDRESS
         ui_host = get_display_cloud_host(api_host)
-        await get_env_info(local_client, config, user_email, token, user_token, api_host, ui_host)
+        return await get_env_info(local_client, config, user_email, token, user_token, api_host, ui_host)
     except Exception:
         click.echo(
             FeedbackManager.warning(
                 message="\n⚠  Could not retrieve Tinybird Local info. Please run `tb local start` first."
             )
         )
-        return
+        return [], []
 
 
 async def get_env_info(
     client: TinyB, config: Dict[str, Any], user_email: str, token: str, user_token: str, api_host: str, ui_host: str
-) -> None:
+) -> Tuple[List[Any], List[str]]:
     user_workspaces = await client.user_workspaces(version="v1")
     current_workspace = await client.workspace_info(version="v1")
 
@@ -94,9 +109,10 @@ async def get_env_info(
     ]
 
     click.echo(format_robust_table(table, column_names=columns))
+    return table, columns
 
 
-async def get_project_info(project_path: Optional[str] = None) -> None:
+async def get_project_info(project_path: Optional[str] = None) -> Tuple[Iterable[Any], List[str]]:
     config = CLIConfig.get_project_config()
     tinyb_path = config.get_tinyb_file()
     current_path = os.getcwd()
@@ -110,3 +126,4 @@ async def get_project_info(project_path: Optional[str] = None) -> None:
     columns = ["current", ".tinyb", "project"]
     table: Iterable[Any] = [(current_path, tinyb_path, project_path)]
     click.echo(format_robust_table(table, column_names=columns))
+    return table, columns

{tinybird-0.0.1.dev170.dist-info → tinybird-0.0.1.dev171.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tinybird
-Version: 0.0.1.dev170
+Version: 0.0.1.dev171
 Summary: Tinybird Command Line Tool
 Home-page: https://www.tinybird.co/docs/forward/commands
 Author: Tinybird

{tinybird-0.0.1.dev170.dist-info → tinybird-0.0.1.dev171.dist-info}/RECORD

@@ -12,15 +12,15 @@ tinybird/syncasync.py,sha256=IPnOx6lMbf9SNddN1eBtssg8vCLHMt76SuZ6YNYm-Yk,27761
 tinybird/tornado_template.py,sha256=jjNVDMnkYFWXflmT8KU_Ssbo5vR8KQq3EJMk5vYgXRw,41959
 tinybird/ch_utils/constants.py,sha256=aYvg2C_WxYWsnqPdZB1ZFoIr8ZY-XjUXYyHKE9Ansj0,3890
 tinybird/ch_utils/engine.py,sha256=X4tE9OrfaUy6kO9cqVEzyI9cDcmOF3IAssRRzsTsfEQ,40781
-tinybird/tb/__cli__.py,sha256=vD6Y8VoWGa0KwaRdT1ksFw14CJ5K3i8ornL8qjiLOt4,247
+tinybird/tb/__cli__.py,sha256=hKG-5atm5V0pGi635mfMITsiz00-mtLOQQlbU2c3LwA,247
 tinybird/tb/check_pypi.py,sha256=rW4QmDRbtgKdUUwJCnBkVjmTjZSZGN-XgZhx7vMkC0w,1009
 tinybird/tb/cli.py,sha256=u3eGOhX0MHkuT6tiwaZ0_3twqLmqKXDAOxF7yV_Nn9Q,1075
 tinybird/tb/client.py,sha256=CSBl_JRuioPyY0H8Ac96dJ9wQXDXfrvK2lwqlOxKGoY,55715
 tinybird/tb/config.py,sha256=jT9xndpeCY_g0HdB5qE2EquC0TFRRnkPnQFWZWd04jo,3998
 tinybird/tb/modules/build.py,sha256=zakH5812Lop-XHjGmDRdOPeofPtoeyb_2un_T6e50xw,19177
 tinybird/tb/modules/cicd.py,sha256=MnShTTJzKBYeajswF2jg7p7ZzupaeCgSriAN05MeEdg,7330
-tinybird/tb/modules/cli.py,sha256=vADGfvo8lOp9-VIYD_d3KVIlcYfQk0ciJawthn-LFaw,14449
-tinybird/tb/modules/common.py,sha256=12SMmfOlEwQZGBUR22KNVNdTXhEMc0BjvDJ7bbqhZf4,83122
+tinybird/tb/modules/cli.py,sha256=3gDO1smcH1e2qEvbFCGbo4oNdgubDr3hC3fsKlB4ylY,15373
+tinybird/tb/modules/common.py,sha256=lu1Z3VYImwocaHvqOW2FzBJP6F3Ev7RuXsItkCZ6jpo,83237
 tinybird/tb/modules/config.py,sha256=ziqW_t_mRVvWOd85VoB4vKyvgMkEfpXDf9H4v38p2xc,11422
 tinybird/tb/modules/connection.py,sha256=7oOR7x4PhBcm1ETFFCH2YJ_3oeGXjAbmx1cnZX9_L70,9014
 tinybird/tb/modules/copy.py,sha256=2Mm4FWKehOG7CoOhiF1m9UZJgJn0W1_cMolqju8ONYg,5805
@@ -32,7 +32,7 @@ tinybird/tb/modules/dev_server.py,sha256=57FCKuWpErwYUYgHspYDkLWEm9F4pbvVOtMrFXX
 tinybird/tb/modules/endpoint.py,sha256=XySDt3pk66vxOZ0egUfz4bY8bEk3BjOXkv-L0OIJ3sc,12083
 tinybird/tb/modules/exceptions.py,sha256=5jK91w1LPmtqIUfDpHe_Op5OxGz8-p1BPgtLREMIni0,5217
 tinybird/tb/modules/feedback_manager.py,sha256=c0ZOpG7IHFq3doodezctX64cTcTquIOhO38w9uPuU8Q,76798
-tinybird/tb/modules/info.py,sha256=AThOatkAjN1HbmARIU0MaQ-N4ZmZlZqoAxN18FQRa6M,4797
+tinybird/tb/modules/info.py,sha256=iKeFbFkos7vYaBU7Vr5SI-fa1x7AbuUHB748jsGsaA4,5944
 tinybird/tb/modules/infra.py,sha256=fve30Gj3mG9zbquGxS2e4ipcOYOxviWQCpNFfEzJN_Q,33195
 tinybird/tb/modules/job.py,sha256=n4dSSBgnA8NqD7srGahf2xRj6wxkmX9Vl0J-QJ_a2w0,2966
 tinybird/tb/modules/llm.py,sha256=KfsCYmKeW1VQz0iDZhGKCRkQv_Y3kTHh6JuxvofOguE,1076
@@ -80,8 +80,8 @@ tinybird/tb_cli_modules/config.py,sha256=IsgdtFRnUrkY8-Zo32lmk6O7u3bHie1QCxLwgp4
 tinybird/tb_cli_modules/exceptions.py,sha256=pmucP4kTF4irIt7dXiG-FcnI-o3mvDusPmch1L8RCWk,3367
 tinybird/tb_cli_modules/regions.py,sha256=QjsL5H6Kg-qr0aYVLrvb1STeJ5Sx_sjvbOYO0LrEGMk,166
 tinybird/tb_cli_modules/telemetry.py,sha256=Hh2Io8ZPROSunbOLuMvuIFU4TqwWPmQTqal4WS09K1A,10449
-tinybird-0.0.1.dev170.dist-info/METADATA,sha256=rh49VPqPEc8mRA4VUEFKfP5H46DQWyL6Q4p1P8sYLnM,1607
-tinybird-0.0.1.dev170.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-tinybird-0.0.1.dev170.dist-info/entry_points.txt,sha256=LwdHU6TfKx4Qs7BqqtaczEZbImgU7Abe9Lp920zb_fo,43
-tinybird-0.0.1.dev170.dist-info/top_level.txt,sha256=VqqqEmkAy7UNaD8-V51FCoMMWXjLUlR0IstvK7tJYVY,54
-tinybird-0.0.1.dev170.dist-info/RECORD,,
+tinybird-0.0.1.dev171.dist-info/METADATA,sha256=DZAvrAPILrw9XpHmGv6LUrVlhFvm7Qy_57YsHR2sA_U,1607
+tinybird-0.0.1.dev171.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+tinybird-0.0.1.dev171.dist-info/entry_points.txt,sha256=LwdHU6TfKx4Qs7BqqtaczEZbImgU7Abe9Lp920zb_fo,43
+tinybird-0.0.1.dev171.dist-info/top_level.txt,sha256=VqqqEmkAy7UNaD8-V51FCoMMWXjLUlR0IstvK7tJYVY,54
+tinybird-0.0.1.dev171.dist-info/RECORD,,