recce-nightly 1.20.0.20250918__py3-none-any.whl → 1.20.0.20250922__py3-none-any.whl

recce/VERSION

@@ -1 +1 @@
-1.20.0.20250918
+1.20.0.20250922

recce/adapter/dbt_adapter/__init__.py

@@ -1591,7 +1591,7 @@ class DbtAdapter(BaseAdapter):
             if not os.path.isfile(path):
                 return None
 
-            with open(path, "r") as f:
+            with open(path, "r", encoding="utf-8") as f:
                 json_content = f.read()
                 return json.loads(json_content)
 

recce/artifact.py

@@ -40,7 +40,7 @@ def verify_artifacts_path(target_path: str) -> bool:
 
 
 def parse_dbt_version(file_path: str) -> str:
-    with open(file_path, "r") as f:
+    with open(file_path, "r", encoding="utf-8") as f:
         data = json.load(f)
 
     dbt_version = data.get("metadata", {}).get("dbt_version", None)
@@ -80,8 +80,8 @@ def archive_artifacts(target_path: str) -> (str, str):
     return artifacts_tar_gz_path, dbt_version
 
 
-def upload_artifacts_to_snapshot(target_path: str, snapshot_id: str, token: str, debug: bool = False):
-    """Upload dbt artifacts to a specific snapshot ID in Recce Cloud."""
+def upload_artifacts_to_session(target_path: str, session_id: str, token: str, debug: bool = False):
+    """Upload dbt artifacts to a specific session ID in Recce Cloud."""
     console = Console()
     if verify_artifacts_path(target_path) is False:
         console.print(f"[[red]Error[/red]] Invalid target path: {target_path}")
@@ -92,7 +92,7 @@ def upload_artifacts_to_snapshot(target_path: str, snapshot_id: str, token: str,
     catalog_path = os.path.join(target_path, "catalog.json")
 
     # get the adapter type from the manifest file
-    with open(manifest_path, "r") as f:
+    with open(manifest_path, "r", encoding="utf-8") as f:
         manifest_data = json.load(f)
         adapter_type = manifest_data.get("metadata", {}).get("adapter_type")
         if adapter_type is None:
@@ -100,29 +100,29 @@ def upload_artifacts_to_snapshot(target_path: str, snapshot_id: str, token: str,
 
     recce_cloud = RecceCloud(token)
 
-    snapshot = recce_cloud.get_snapshot(snapshot_id)
+    session = recce_cloud.get_session(session_id)
 
-    org_id = snapshot.get("org_id")
+    org_id = session.get("org_id")
     if org_id is None:
-        raise Exception(f"Snapshot ID {snapshot_id} does not belong to any organization.")
+        raise Exception(f"Session ID {session_id} does not belong to any organization.")
 
-    project_id = snapshot.get("project_id")
+    project_id = session.get("project_id")
     if project_id is None:
-        raise Exception(f"Snapshot ID {snapshot_id} does not belong to any project.")
+        raise Exception(f"Session ID {session_id} does not belong to any project.")
 
-    # Get the presigned URL for uploading the artifacts using snapshot ID
-    console.print(f'Uploading artifacts for snapshot ID "{snapshot_id}"')
-    presigned_urls = recce_cloud.get_upload_urls_by_snapshot_id(org_id, project_id, snapshot_id)
+    # Get the presigned URL for uploading the artifacts using session ID
+    console.print(f'Uploading artifacts for session ID "{session_id}"')
+    presigned_urls = recce_cloud.get_upload_urls_by_session_id(org_id, project_id, session_id)
     if debug:
         console.rule("Debug information", style="blue")
         console.print(f"Org ID: {org_id}")
         console.print(f"Project ID: {project_id}")
-        console.print(f"Snapshot ID: {snapshot_id}")
+        console.print(f"Session ID: {session_id}")
         console.print(f"Manifest path: {presigned_urls['manifest_url']}")
         console.print(f"Catalog path: {presigned_urls['catalog_url']}")
         console.print(f"Adapter type: {adapter_type}")
 
-    # Upload the compressed artifacts (no password needed for snapshot uploads)
+    # Upload the compressed artifacts (no password needed for session uploads)
     console.print(f'Uploading manifest from path "{manifest_path}"')
     response = requests.put(presigned_urls["manifest_url"], data=open(manifest_path, "rb").read())
     if response.status_code != 200 and response.status_code != 204:
@@ -132,8 +132,8 @@ def upload_artifacts_to_snapshot(target_path: str, snapshot_id: str, token: str,
     if response.status_code != 200 and response.status_code != 204:
         raise Exception(response.text)
 
-    # Update the snapshot metadata
-    recce_cloud.update_snapshot(org_id, project_id, snapshot_id, adapter_type)
+    # Update the session metadata
+    recce_cloud.update_session(org_id, project_id, session_id, adapter_type)
 
     return 0
 

recce/cli.py

@@ -10,7 +10,7 @@ from click import Abort
 from recce import event
 from recce.artifact import (
     download_dbt_artifacts,
-    upload_artifacts_to_snapshot,
+    upload_artifacts_to_session,
     upload_dbt_artifacts,
 )
 from recce.config import RECCE_CONFIG_FILE, RECCE_ERROR_LOG_FILE, RecceConfig
@@ -143,6 +143,12 @@ recce_cloud_options = [
     ),
 ]
 
+recce_cloud_auth_options = [
+    click.option(
+        "--api-token", help="The personal token generated by Recce Cloud.", type=click.STRING, envvar="RECCE_API_TOKEN"
+    )
+]
+
 recce_dbt_artifact_dir_options = [
     click.option(
         "--target-path",
@@ -173,10 +179,10 @@ recce_hidden_options = [
         hidden=True,
     ),
     click.option(
-        "--snapshot-id",
-        help="The snapshot ID triggers this instance.",
+        "--session-id",
+        help="The session ID triggers this instance.",
         type=click.STRING,
-        envvar="RECCE_SNAPSHOT_ID",
+        envvar=["RECCE_SESSION_ID", "RECCE_SNAPSHOT_ID"],  # Backward compatibility with RECCE_SNAPSHOT_ID
         hidden=True,
     ),
 ]
@@ -460,7 +466,7 @@ def server(host, port, lifetime, state_file=None, **kwargs):
     }
 
     share_url = kwargs.get("share_url")
-    snapshot_id = kwargs.get("snapshot_id")
+    session_id = kwargs.get("session_id")
     if share_url:
         share_id = share_url.split("/")[-1]
         if not share_id:
@@ -476,12 +482,12 @@ def server(host, port, lifetime, state_file=None, **kwargs):
                 "api_token": api_token,
                 "share_id": share_id,
             }
-        elif snapshot_id:
+        elif session_id:
             is_review = kwargs["review"] = True
             cloud_options = {
                 "host": kwargs.get("state_file_host"),
                 "api_token": api_token,
-                "snapshot_id": snapshot_id,
+                "session_id": session_id,
             }
         else:
             cloud_options = {
@@ -1177,6 +1183,227 @@ def download_base_artifacts(**kwargs):
     return _download_artifacts(branch, cloud_token, console, kwargs, password, target_path)
 
 
+@cloud.command(cls=TrackCommand, name="list-organizations")
+@click.option("--api-token", help="The Recce Cloud API token.", type=click.STRING, envvar="RECCE_CLOUD_API_TOKEN")
+@add_options(recce_options)
+def list_organizations(**kwargs):
+    """
+    List organizations from Recce Cloud
+
+    Lists all organizations that the authenticated user has access to.
+    """
+    from rich.console import Console
+    from rich.table import Table
+
+    console = Console()
+    handle_debug_flag(**kwargs)
+
+    try:
+        api_token = prepare_api_token(**kwargs)
+    except RecceConfigException:
+        show_invalid_api_token_message()
+        exit(1)
+
+    try:
+        from recce.util.recce_cloud import RecceCloud
+
+        cloud = RecceCloud(api_token)
+        organizations = cloud.list_organizations()
+
+        if not organizations:
+            console.print("No organizations found.")
+            return
+
+        table = Table(title="Organizations")
+        table.add_column("ID", style="cyan")
+        table.add_column("Name", style="green")
+        table.add_column("Display Name", style="yellow")
+
+        for org in organizations:
+            table.add_row(str(org.get("id", "")), org.get("name", ""), org.get("display_name", ""))
+
+        console.print(table)
+
+    except RecceCloudException as e:
+        console.print(f"[[red]Error[/red]] {e}")
+        exit(1)
+    except Exception as e:
+        console.print(f"[[red]Error[/red]] {e}")
+        exit(1)
+
+
+@cloud.command(cls=TrackCommand, name="list-projects")
+@click.option(
+    "--organization",
+    "-o",
+    help="Organization ID (can also be set via RECCE_ORGANIZATION_ID environment variable)",
+    type=click.STRING,
+    envvar="RECCE_ORGANIZATION_ID",
+)
+@click.option("--api-token", help="The Recce Cloud API token.", type=click.STRING, envvar="RECCE_CLOUD_API_TOKEN")
+@add_options(recce_options)
+def list_projects(**kwargs):
+    """
+    List projects from Recce Cloud
+
+    Lists all projects in the specified organization that the authenticated user has access to.
+
+    Examples:
+
+        # Using environment variable
+        export RECCE_ORGANIZATION_ID=8
+        recce cloud list-projects
+
+        # Using command line argument
+        recce cloud list-projects --organization 8
+
+        # Override environment variable
+        export RECCE_ORGANIZATION_ID=8
+        recce cloud list-projects --organization 10
+    """
+    from rich.console import Console
+    from rich.table import Table
+
+    console = Console()
+    handle_debug_flag(**kwargs)
+
+    try:
+        api_token = prepare_api_token(**kwargs)
+    except RecceConfigException:
+        show_invalid_api_token_message()
+        exit(1)
+
+    organization = kwargs.get("organization")
+    if not organization:
+        console.print("[[red]Error[/red]] Organization ID is required. Please provide it via:")
+        console.print("  --organization <id> or set RECCE_ORGANIZATION_ID environment variable")
+        exit(1)
+
+    try:
+        from recce.util.recce_cloud import RecceCloud
+
+        cloud = RecceCloud(api_token)
+        projects = cloud.list_projects(organization)
+
+        if not projects:
+            console.print(f"No projects found in organization {organization}.")
+            return
+
+        table = Table(title=f"Projects in Organization {organization}")
+        table.add_column("ID", style="cyan")
+        table.add_column("Name", style="green")
+        table.add_column("Display Name", style="yellow")
+
+        for project in projects:
+            table.add_row(str(project.get("id", "")), project.get("name", ""), project.get("display_name", ""))
+
+        console.print(table)
+
+    except RecceCloudException as e:
+        console.print(f"[[red]Error[/red]] {e}")
+        exit(1)
+    except Exception as e:
+        console.print(f"[[red]Error[/red]] {e}")
+        exit(1)
+
+
+@cloud.command(cls=TrackCommand, name="list-sessions")
+@click.option(
+    "--organization",
+    "-o",
+    help="Organization ID (can also be set via RECCE_ORGANIZATION_ID environment variable)",
+    type=click.STRING,
+    envvar="RECCE_ORGANIZATION_ID",
+)
+@click.option(
+    "--project",
+    "-p",
+    help="Project ID (can also be set via RECCE_PROJECT_ID environment variable)",
+    type=click.STRING,
+    envvar="RECCE_PROJECT_ID",
+)
+@click.option("--api-token", help="The Recce Cloud API token.", type=click.STRING, envvar="RECCE_CLOUD_API_TOKEN")
+@add_options(recce_options)
+def list_sessions(**kwargs):
+    """
+    List sessions from Recce Cloud
+
+    Lists all sessions in the specified project that the authenticated user has access to.
+
+    Examples:
+
+        # Using environment variables
+        export RECCE_ORGANIZATION_ID=8
+        export RECCE_PROJECT_ID=7
+        recce cloud list-sessions
+
+        # Using command line arguments
+        recce cloud list-sessions --organization 8 --project 7
+
+        # Mixed usage (env + CLI override)
+        export RECCE_ORGANIZATION_ID=8
+        recce cloud list-sessions --project 7
+
+        # Override environment variables
+        export RECCE_ORGANIZATION_ID=8
+        export RECCE_PROJECT_ID=7
+        recce cloud list-sessions --organization 10 --project 9
+    """
+    from rich.console import Console
+    from rich.table import Table
+
+    console = Console()
+    handle_debug_flag(**kwargs)
+
+    try:
+        api_token = prepare_api_token(**kwargs)
+    except RecceConfigException:
+        show_invalid_api_token_message()
+        exit(1)
+
+    organization = kwargs.get("organization")
+    project = kwargs.get("project")
+
+    # Validate required parameters
+    if not organization:
+        console.print("[[red]Error[/red]] Organization ID is required. Please provide it via:")
+        console.print("  --organization <id> or set RECCE_ORGANIZATION_ID environment variable")
+        exit(1)
+
+    if not project:
+        console.print("[[red]Error[/red]] Project ID is required. Please provide it via:")
+        console.print("  --project <id> or set RECCE_PROJECT_ID environment variable")
+        exit(1)
+
+    try:
+        from recce.util.recce_cloud import RecceCloud
+
+        cloud = RecceCloud(api_token)
+        sessions = cloud.list_sessions(organization, project)
+
+        if not sessions:
+            console.print(f"No sessions found in project {project}.")
+            return
+
+        table = Table(title=f"Sessions in Project {project}")
+        table.add_column("ID", style="cyan")
+        table.add_column("Name", style="green")
+        table.add_column("Is Base", style="yellow")
+
+        for session in sessions:
+            is_base = "✓" if session.get("is_base", False) else ""
+            table.add_row(session.get("id", ""), session.get("name", ""), is_base)
+
+        console.print(table)
+
+    except RecceCloudException as e:
+        console.print(f"[[red]Error[/red]] {e}")
+        exit(1)
+    except Exception as e:
+        console.print(f"[[red]Error[/red]] {e}")
+        exit(1)
+
+
 @cli.group("github", short_help="GitHub related commands", hidden=True)
 def github(**kwargs):
     pass
@@ -1264,41 +1491,51 @@ def share(state_file, **kwargs):
         exit(1)
 
 
-@cli.command(cls=TrackCommand, hidden=True)
-@click.option(
+snapshot_id_option = click.option(
     "--snapshot-id",
     help="The snapshot ID to upload artifacts to cloud.",
     type=click.STRING,
-    envvar="RECCE_SNAPSHOT_ID",
+    envvar=["RECCE_SNAPSHOT_ID", "RECCE_SESSION_ID"],
     required=True,
 )
-@click.option(
+
+session_id_option = click.option(
+    "--session-id",
+    help="The session ID to upload artifacts to cloud.",
+    type=click.STRING,
+    envvar=["RECCE_SESSION_ID", "RECCE_SNAPSHOT_ID"],
+    required=True,
+)
+
+target_path_option = click.option(
     "--target-path",
     help="dbt artifacts directory for your artifacts.",
     type=click.STRING,
     default="target",
     show_default=True,
 )
-@click.option(
-    "--api-token", help="The personal token generated by Recce Cloud.", type=click.STRING, envvar="RECCE_API_TOKEN"
-)
+
+
+@cli.command(cls=TrackCommand, hidden=True)
+@add_options([session_id_option, target_path_option])
+@add_options(recce_cloud_auth_options)
 @add_options(recce_options)
-def snapshot(**kwargs):
+def upload_session(**kwargs):
     """
-    Upload target/manifest.json and target/catalog.json to the specific snapshot ID
+    Upload target/manifest.json and target/catalog.json to the specific session ID
 
-    Upload the dbt artifacts (manifest.json, catalog.json) to Recce Cloud for the given snapshot ID.
-    This allows you to associate artifacts with a specific snapshot for later use.
+    Upload the dbt artifacts (manifest.json, catalog.json) to Recce Cloud for the given session ID.
+    This allows you to associate artifacts with a specific session for later use.
 
     Examples:\n
 
     \b
-    # Upload artifacts to a snapshot ID
-    recce snapshot --snapshot-id <snapshot-id>
+    # Upload artifacts to a session ID
+    recce upload-session --session-id <session-id>
 
     \b
-    # Upload artifacts from custom target path to a snapshot ID
-    recce snapshot --snapshot-id <snapshot-id> --target-path my-target
+    # Upload artifacts from custom target path to a session ID
+    recce upload-session --session-id <session-id> --target-path my-target
     """
     from rich.console import Console
 
@@ -1314,25 +1551,40 @@ def snapshot(**kwargs):
         show_invalid_api_token_message()
         exit(1)
 
-    snapshot_id = kwargs.get("snapshot_id")
+    session_id = kwargs.get("session_id")
     target_path = kwargs.get("target_path")
 
     try:
-        rc = upload_artifacts_to_snapshot(
-            target_path, snapshot_id=snapshot_id, token=api_token, debug=kwargs.get("debug", False)
+        rc = upload_artifacts_to_session(
+            target_path, session_id=session_id, token=api_token, debug=kwargs.get("debug", False)
         )
         console.rule("Uploaded Successfully")
         console.print(
-            f'Uploaded dbt artifacts to Recce Cloud for snapshot ID "{snapshot_id}" from "{os.path.abspath(target_path)}"'
+            f'Uploaded dbt artifacts to Recce Cloud for session ID "{session_id}" from "{os.path.abspath(target_path)}"'
         )
     except Exception as e:
-        console.rule("Failed to Snapshot", style="red")
-        console.print(f"[[red]Error[/red]] Failed to upload the dbt artifacts to the snapshot {snapshot_id}.")
+        console.rule("Failed to Upload Session", style="red")
+        console.print(f"[[red]Error[/red]] Failed to upload the dbt artifacts to the session {session_id}.")
         console.print(f"Reason: {e}")
         rc = 1
     return rc
 
 
+# Backward compatibility for `recce snapshot` command
+@cli.command(
+    cls=TrackCommand,
+    hidden=True,
+    deprecated=True,
+    help="Upload target/manifest.json and target/catalog.json to the specific snapshot ID",
+)
+@add_options([snapshot_id_option, target_path_option])
+@add_options(recce_cloud_auth_options)
+@add_options(recce_options)
+def snapshot(**kwargs):
+    kwargs["session_id"] = kwargs.get("snapshot_id")
+    return upload_session(**kwargs)
+
+
 @cli.command(hidden=True, cls=TrackCommand)
 @click.argument("state_file", required=True)
 @click.option("--host", default="localhost", show_default=True, help="The host to bind to.")

recce/config.py

@@ -21,7 +21,7 @@ class RecceConfig(metaclass=SingletonMeta):
 
     def load(self):
         try:
-            with open(self.config_file, "r") as f:
+            with open(self.config_file, "r", encoding="utf-8") as f:
                 config = yaml.safe_load(f)
                 self.config = config if config else {}
             self._verify_preset_checks()
@@ -117,7 +117,7 @@ class RecceConfig(metaclass=SingletonMeta):
         self.config[key] = value
 
     def save(self):
-        with open(RECCE_CONFIG_FILE, "w") as f:
+        with open(RECCE_CONFIG_FILE, "w", encoding="utf-8") as f:
             yaml.dump(self.config, f)
 
     def __str__(self):

recce/connect_to_cloud.py

@@ -58,7 +58,7 @@ def make_callback_handler(private_key: RSAPrivateKey):
     class OneTimeHTTPRequestHandler(BaseHTTPRequestHandler):
         def do_GET(self):
             try:
-                with open(os.path.join(static_folder_path, "auth_callback.html"), "r") as f:
+                with open(os.path.join(static_folder_path, "auth_callback.html"), "r", encoding="utf-8") as f:
                     callback_html_content = f.read()
 
                 # Parse query parameters