PyPI - recce-cloud - Versions diffs - 1.34.0__py3-none-any.whl → 1.35.0__py3-none-any.whl - Mend

recce-cloud 1.34.0py3-none-any.whl → 1.35.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

recce_cloud/VERSION +1 -1
recce_cloud/cli.py +10 -13
recce_cloud-1.35.0.dist-info/METADATA +397 -0
{recce_cloud-1.34.0.dist-info → recce_cloud-1.35.0.dist-info}/RECORD +6 -6
{recce_cloud-1.34.0.dist-info → recce_cloud-1.35.0.dist-info}/entry_points.txt +1 -0
recce_cloud-1.34.0.dist-info/METADATA +0 -914
{recce_cloud-1.34.0.dist-info → recce_cloud-1.35.0.dist-info}/WHEEL +0 -0

recce_cloud/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 1.34.0
1	+ 1.35.0

recce_cloud/cli.py CHANGED Viewed

@@ -43,6 +43,7 @@ logging.getLogger("recce_cloud.ci_providers.detector").setLevel(logging.WARNING)
 @click.group()
+@click.version_option(version=__version__, prog_name="recce-cloud")
 def cloud_cli():
     """
     Recce Cloud CLI - Manage Recce Cloud sessions and state files.
@@ -158,11 +159,11 @@ def logout():
 @cloud_cli.command()
 @click.option(
     "--org",
-    help="Organization name or slug to bind to",
+    help="Organization ID, name, or slug to bind to",
 )
 @click.option(
     "--project",
-    help="Project name or slug to bind to",
+    help="Project ID, name, or slug to bind to",
 )
 @click.option(
     "--status",
@@ -257,13 +258,15 @@ def init(org, project, status, clear):
             api = RecceCloudClient(token)
             org_obj = api.get_organization(org)
             if not org_obj:
-                console.print(f"[red]Error:[/red] Organization '{org}' not found")
+                console.print(f"[red]Error:[/red] Organization '{org}' not found or you don't have access")
                 sys.exit(1)
             # Use org ID for project lookup (API requires ID)
             project_obj = api.get_project(org_obj.get("id"), project)
             if not project_obj:
-                console.print(f"[red]Error:[/red] Project '{project}' not found in organization '{org}'")
+                console.print(
+                    f"[red]Error:[/red] Project '{project}' not found in organization '{org}' or you don't have access"
+                )
                 sys.exit(1)
             # Store IDs (immutable) instead of slugs (can be renamed)
@@ -276,13 +279,7 @@ def init(org, project, status, clear):
             )
             console.print(f"  Config saved to {get_config_path()}")
-            # Offer to add to .gitignore
-            if click.confirm("Add .recce/ to .gitignore?", default=True):
-                if add_to_gitignore():
-                    console.print("[green]✓[/green] Added .recce/ to .gitignore")
-                else:
-                    console.print("  .recce/ already in .gitignore")
+            # Skip gitignore prompt in explicit mode (scripted/CI usage)
             sys.exit(0)
         except RecceCloudException as e:
@@ -363,8 +360,8 @@ def init(org, project, status, clear):
         )
         console.print(f"  Config saved to {get_config_path()}")
-        # Offer to add to .gitignore
-        if click.confirm("Add .recce/ to .gitignore?", default=True):
+        # Offer to add to .gitignore (default: No, since .recce/config should typically be committed)
+        if click.confirm("Add .recce/ to .gitignore?", default=False):
             if add_to_gitignore():
                 console.print("[green]✓[/green] Added .recce/ to .gitignore")
             else:

recce_cloud-1.35.0.dist-info/METADATA ADDED Viewed

@@ -0,0 +1,397 @@
+Metadata-Version: 2.4
+Name: recce-cloud
+Version: 1.35.0
+Summary: Lightweight CLI for Recce Cloud operations
+Project-URL: Homepage, https://cloud.reccehq.com
+Project-URL: Documentation, https://docs.reccehq.com
+Project-URL: Repository, https://github.com/DataRecce/recce
+Project-URL: Bug Tracker, https://github.com/DataRecce/recce/issues
+Project-URL: Changelog, https://github.com/DataRecce/recce/releases
+Author-email: InfuseAI Dev Team <dev@infuseai.io>
+License: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: click>=7.1
+Requires-Dist: cryptography>=3.4
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.28.1
+Requires-Dist: rich>=12.0.0
+Provides-Extra: dev
+Requires-Dist: flake8>=7.2.0; extra == 'dev'
+Requires-Dist: pytest>=4.6; extra == 'dev'
+Description-Content-Type: text/markdown
+# Recce Cloud CLI
+Lightweight command-line tool for managing dbt artifacts with Recce Cloud in
+CI/CD environments.
+## Overview
+The Recce Cloud CLI (`recce-cloud`) is a standalone tool designed for CI/CD
+pipelines that need to upload and download dbt artifacts (manifest.json and
+catalog.json) to/from Recce Cloud without the full `recce` package dependencies.
+**Key Features:**
+- Lightweight - minimal dependencies for fast CI/CD execution
+- Auto-detection - automatically detects CI platform, repository, and PR/MR
+  context
+- Upload/Download - push and pull dbt artifacts to/from Recce Cloud sessions
+- Flexible authentication - browser-based login, token-based auth, or CI tokens
+- Platform-specific - optimized for GitHub Actions and GitLab CI
+## Installation
+### Quick Run (no install needed)
+Using [uv](https://github.com/astral-sh/uv), you can run `recce-cloud` directly
+without installation:
+```bash
+# Run with uvx (creates temporary isolated environment)
+uvx recce-cloud upload --type prod
+uvx recce-cloud download --prod --target-path target-base
+# Short alias also available
+uvx --from recce-cloud rcc upload --type prod
+```
+### Permanent Install
+```bash
+# With uv (recommended)
+uv tool install recce-cloud
+# With pip
+pip install recce-cloud
+# With pipx
+pipx install recce-cloud
+```
+## Quick Start
+### Local Development
+```bash
+# Login to Recce Cloud (opens browser for authentication)
+recce-cloud login
+# Initialize project binding (interactive)
+recce-cloud init
+# Check current status
+recce-cloud init --status
+# Logout
+recce-cloud logout
+```
+### GitHub Actions
+```yaml
+- name: Upload to Recce Cloud
+  run: recce-cloud upload
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+- name: Download from Recce Cloud
+  run: recce-cloud download --prod --target-path target-base
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+### GitLab CI
+```yaml
+recce-upload:
+  script:
+    - recce-cloud upload
+recce-download:
+  script:
+    - recce-cloud download --prod --target-path target-base
+```
+## CI/CD Workflows
+### Upload Workflow
+The `recce-cloud upload` command automatically creates sessions in supported CI
+environments.
+```bash
+# Basic upload (auto-detects CI context)
+recce-cloud upload
+# Custom target path
+recce-cloud upload --target-path custom-target
+# Override PR number or session type
+recce-cloud upload --pr 123 --type pr
+# Generic workflow with session name (for other CI platforms)
+recce-cloud upload --session-name "PR-123" --yes
+```
+**Options:**
+| Option           | Description                                      |
+| ---------------- | ------------------------------------------------ |
+| `--target-path`  | Path to dbt target directory (default: `target`) |
+| `--session-id`   | Session ID for generic workflow                  |
+| `--session-name` | Session name for human-readable workflow         |
+| `--pr`           | Override PR/MR number                            |
+| `--type`         | Override session type: `pr`, `prod`, `dev`       |
+| `--yes`          | Auto-confirm session creation                    |
+| `--dry-run`      | Preview without uploading                        |
+### Download Workflow
+The `recce-cloud download` command retrieves artifacts from Recce Cloud
+sessions.
+```bash
+# Download current PR/MR session
+recce-cloud download
+# Download production/base session
+recce-cloud download --prod
+# Download to custom path
+recce-cloud download --prod --target-path target-base
+# Force overwrite existing files
+recce-cloud download --force
+# Generic workflow with session ID
+recce-cloud download --session-id abc123
+```
+**Options:**
+| Option          | Description                              |
+| --------------- | ---------------------------------------- |
+| `--target-path` | Download destination (default: `target`) |
+| `--session-id`  | Session ID for generic workflow          |
+| `--prod`        | Download production/base session         |
+| `--force`, `-f` | Overwrite existing files                 |
+| `--dry-run`     | Preview without downloading              |
+## Authentication
+The CLI supports multiple authentication methods (in priority order):
+1. **RECCE_API_TOKEN** - Environment variable (recommended for CI)
+2. **GITHUB_TOKEN** - GitHub Actions (must be explicitly set)
+3. **CI_JOB_TOKEN** - GitLab CI (auto-detected)
+4. **Stored credentials** - From `recce-cloud login`
+### Getting API Tokens
+**Recce Cloud API Token:**
+1. Log in to [Recce Cloud](https://cloud.datarecce.io)
+2. Go to Settings → API Tokens
+## CI/CD Integration Examples
+### GitHub Actions - Complete Workflow
+```yaml
+name: Recce CI
+on:
+  pull_request:
+    branches: [main]
+jobs:
+  recce:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: pip install dbt-core dbt-snowflake recce-cloud
+      # Download production artifacts for comparison
+      - name: Download base artifacts
+        run: recce-cloud download --prod --target-path target-base
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Build current PR
+      - name: Build dbt project
+        run: |
+          dbt deps
+          dbt build
+          dbt docs generate
+      # Upload current PR artifacts
+      - name: Upload to Recce Cloud
+        run: recce-cloud upload
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+### GitLab CI - Complete Workflow
+```yaml
+stages:
+  - download
+  - build
+  - upload
+recce-download-base:
+  stage: download
+  image: python:3.11-slim
+  script:
+    - pip install recce-cloud
+    - recce-cloud download --prod --target-path target-base
+  artifacts:
+    paths:
+      - target-base/
+  only:
+    - merge_requests
+dbt-build:
+  stage: build
+  image: python:3.11-slim
+  script:
+    - pip install dbt-core dbt-snowflake
+    - dbt deps
+    - dbt build
+    - dbt docs generate
+  artifacts:
+    paths:
+      - target/
+  only:
+    - merge_requests
+recce-upload:
+  stage: upload
+  image: python:3.11-slim
+  script:
+    - pip install recce-cloud
+    - recce-cloud upload
+  dependencies:
+    - dbt-build
+  only:
+    - merge_requests
+```
+### Generic CI Platform
+For other CI platforms, use session name workflow with your PR/MR number:
+```bash
+export RECCE_API_TOKEN=your_token_here
+# Upload PR artifacts (creates session if not exists)
+recce-cloud upload --session-name "PR-${PR_NUMBER}" --yes
+# Upload production artifacts (in CD pipeline after merge)
+recce-cloud upload --type prod --yes
+```
+The `--session-name` option creates a human-readable session that's easy to
+track. Use `--yes` to auto-confirm session creation in CI environments.
+## Environment Variables
+| Variable           | Description                              |
+| ------------------ | ---------------------------------------- |
+| `RECCE_API_TOKEN`  | Recce Cloud API token                    |
+| `RECCE_SESSION_ID` | Default session ID for generic workflows |
+| `GITHUB_TOKEN`     | GitHub authentication (Actions)          |
+| `CI_JOB_TOKEN`     | GitLab CI job token (auto-detected)      |
+## Additional Commands
+Beyond upload and download, the CLI provides:
+```bash
+# List sessions in your project
+recce-cloud list
+# Delete a session
+recce-cloud delete --session-id abc123
+# Generate AI review for a session
+recce-cloud review --session-id abc123
+# Generate PR metrics report
+recce-cloud report --since 30d
+# Diagnose setup issues
+recce-cloud doctor
+# Show version
+recce-cloud version
+```
+Run `recce-cloud <command> --help` for detailed options.
+## Troubleshooting
+### Quick Diagnosis
+```bash
+recce-cloud doctor
+```
+This validates login status, project binding, and session availability.
+### Common Issues
+**Missing dbt artifacts:**
+```bash
+dbt build
+dbt docs generate  # Required before upload
+recce-cloud upload
+```
+**Authentication failed:**
+- For GitHub Actions: Set `GITHUB_TOKEN` in env
+- For GitLab CI: `CI_JOB_TOKEN` is auto-detected
+- For generic CI: Set `RECCE_API_TOKEN`
+**Platform not supported:**
+```bash
+# Use session name workflow for unsupported CI platforms
+recce-cloud upload --session-name "PR-${PR_NUMBER}" --yes
+```
+### Debug Mode
+```bash
+export RECCE_LOG_LEVEL=DEBUG
+recce-cloud upload
+```
+## Support
+- **Documentation:** [docs.reccehq.com](https://docs.reccehq.com)
+- **Issues:** [GitHub Issues](https://github.com/DataRecce/recce/issues)
+- **Community:** [Recce Slack](https://getdbt.slack.com/archives/C05C28V7CPP)
+- **Email:** <support@reccehq.com>
+## License
+Apache License 2.0 - See [LICENSE](../LICENSE) file for details.

{recce_cloud-1.34.0.dist-info → recce_cloud-1.35.0.dist-info}/RECORD RENAMED Viewed

@@ -1,7 +1,7 @@
-recce_cloud/VERSION,sha256=xBVSUVA8aWplLFRKB0ZS35rrhaZQwe68qZ7iCifdheg,7
+recce_cloud/VERSION,sha256=w00ZuN3Pb5FuTkM1TToiBY3LWEqVfWKslnBS7HuzpCQ,7
 recce_cloud/__init__.py,sha256=2Zlm9V1IBJ9DxovzHIUJB0QDl6ergO5ktY09baQ-Kxc,907
 recce_cloud/artifact.py,sha256=C6q1i8d0JdTIVLcJY1ZEmJJ0uBz-0g3zVZD8ss0K1iI,1458
-recce_cloud/cli.py,sha256=eFS4WQkL-1K7gdSe4Cc9g6y-8QbcTc-5CgaKJMFGfe4,56652
+recce_cloud/cli.py,sha256=aLOmimn3S9HLL8OI-b6HD1tlx-D5WS009BCqsD0M9zo,56627
 recce_cloud/delete.py,sha256=sZSJkCLcTkiI2qVRUZwV5vqqV3BRzzuRUKdTLlVZfr0,3751
 recce_cloud/download.py,sha256=bNBkh2tKLdFoQIuZNXG_wcP46VPCO_WlVszSmHAseGE,8482
 recce_cloud/report.py,sha256=MRlT-CGV-SBzzYepp1zzoFuHqomC2vhpn7s5ACoNyyQ,10214
@@ -32,7 +32,7 @@ recce_cloud/config/project_config.py,sha256=sfToZjP1TZNnSr31x0pwpLc_2DBZywrcqNpY
 recce_cloud/config/resolver.py,sha256=EYsWX0dwKHVKYf6kftekrbWd17vrALMUMl-T26up4VM,4712
 recce_cloud/services/__init__.py,sha256=GMxN0Wtf166qvSSMGmU5jwqfly5b3K0vsIe8PkX7AKo,36
 recce_cloud/services/diagnostic_service.py,sha256=X3YBHFTkB31WRIH9MCKpZxbl4drw9evD6bBiD8cDIkw,13049
-recce_cloud-1.34.0.dist-info/METADATA,sha256=4TjurNAzv-MoZrNEVnzMS1JPm4juK9EqzaL_ZavJdjo,22589
-recce_cloud-1.34.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-recce_cloud-1.34.0.dist-info/entry_points.txt,sha256=MVzgsEDWaQ4fWf33zlyPF83wg5Rgg5Axq2hlLEf0Yxg,58
-recce_cloud-1.34.0.dist-info/RECORD,,
+recce_cloud-1.35.0.dist-info/METADATA,sha256=ps18ZQ1kVOS3rFgSBsiuCkbuz-qy_bFQZYGfEb8l7tg,9872
+recce_cloud-1.35.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+recce_cloud-1.35.0.dist-info/entry_points.txt,sha256=_1wH_y7frAGRQPL8CDFUKhgYERZl9md_soULvqZfU3k,90
+recce_cloud-1.35.0.dist-info/RECORD,,

{recce_cloud-1.34.0.dist-info → recce_cloud-1.35.0.dist-info}/entry_points.txt RENAMED Viewed

@@ -1,2 +1,3 @@
 [console_scripts]
+rcc = recce_cloud.cli:cloud_cli
 recce-cloud = recce_cloud.cli:cloud_cli

recce_cloud-1.34.0.dist-info/METADATA DELETED Viewed

@@ -1,914 +0,0 @@
-Metadata-Version: 2.4
-Name: recce-cloud
-Version: 1.34.0
-Summary: Lightweight CLI for Recce Cloud operations
-Project-URL: Bug Tracker, https://github.com/InfuseAI/recce/issues
-Author-email: InfuseAI Dev Team <dev@infuseai.io>
-License: Apache-2.0
-Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
-Requires-Dist: click>=7.1
-Requires-Dist: cryptography>=3.4
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: requests>=2.28.1
-Requires-Dist: rich>=12.0.0
-Provides-Extra: dev
-Requires-Dist: flake8>=7.2.0; extra == 'dev'
-Requires-Dist: pytest>=4.6; extra == 'dev'
-Description-Content-Type: text/markdown
-# Recce Cloud CLI
-Lightweight command-line tool for managing dbt artifacts with Recce Cloud in CI/CD environments.
-## Overview
-The Recce Cloud CLI (`recce-cloud`) is a standalone tool designed for CI/CD pipelines that need to upload and download dbt artifacts (manifest.json and catalog.json) to/from Recce Cloud without the full `recce` package dependencies.
-**Key Features:**
-- 🚀 Lightweight - minimal dependencies for fast CI/CD execution
-- 🤖 Auto-detection - automatically detects CI platform, repository, and PR/MR context
-- ⬆️ Upload - push dbt artifacts to Recce Cloud sessions
-- ⬇️ Download - pull dbt artifacts from Recce Cloud sessions
-- 🔐 Flexible authentication - browser-based login, token-based auth, or CI tokens
-- 🔗 Project binding - link local projects to Recce Cloud organizations
-- ✅ Platform-specific - optimized for GitHub Actions and GitLab CI
-## Installation
-```bash
-pip install recce-cloud
-```
-Or in your CI/CD workflow:
-```yaml
-# GitHub Actions
-- name: Install recce-cloud
-  run: pip install recce-cloud
-# GitLab CI
-install:
-  script:
-    - pip install recce-cloud
-```
-## Quick Start
-### Local Development
-**Login to Recce Cloud:**
-```bash
-# Browser-based login (recommended)
-recce-cloud login
-# Token-based login (for headless environments)
-recce-cloud login --token <your-api-token>
-```
-**Initialize project binding:**
-```bash
-# Interactive project selection
-recce-cloud init
-# Check current status
-recce-cloud status
-```
-**Logout:**
-```bash
-recce-cloud logout
-```
-### GitHub Actions
-**Upload artifacts:**
-```yaml
-- name: Upload to Recce Cloud
-  run: recce-cloud upload
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-**Download artifacts:**
-```yaml
-- name: Download from Recce Cloud
-  run: recce-cloud download --prod --target-path target-base
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-### GitLab CI
-**Upload artifacts:**
-```yaml
-recce-upload:
-  script:
-    - recce-cloud upload
-```
-**Download artifacts:**
-```yaml
-recce-download:
-  script:
-    - recce-cloud download --prod --target-path target-base
-```
-## Upload Workflows
-The `recce-cloud upload` command supports two workflows:
-### 1. Platform-Specific Workflow (Recommended)
-**For GitHub Actions and GitLab CI**
-Automatically creates Recce Cloud sessions using platform-specific APIs. No session ID required.
-**Features:**
-- ✅ Auto-creates session with `touch-recce-session` API
-- ✅ Auto-detects PR/MR context and links session
-- ✅ Notifies upload completion
-- ✅ Works with CI-provided tokens (GITHUB_TOKEN, CI_JOB_TOKEN)
-**Usage:**
-```bash
-# GitHub Actions
-recce-cloud upload
-# GitLab CI
-recce-cloud upload
-# With custom target path
-recce-cloud upload --target-path custom-target
-# With manual overrides
-recce-cloud upload --pr 123 --type pr
-```
-**Requirements:**
-- Running in GitHub Actions or GitLab CI environment
-- RECCE_API_TOKEN or CI-provided token (GITHUB_TOKEN/CI_JOB_TOKEN)
-- dbt artifacts in target directory
-### 2. Generic Workflow
-**For other CI platforms or existing sessions**
-Uploads to a pre-existing Recce Cloud session using session ID.
-**Usage:**
-```bash
-# With session ID parameter
-recce-cloud upload --session-id abc123
-# With environment variable
-export RECCE_SESSION_ID=abc123
-recce-cloud upload
-# With custom target path
-recce-cloud upload --session-id abc123 --target-path my-target
-```
-**Requirements:**
-- Pre-created session ID (from Recce Cloud web app or API)
-- RECCE_API_TOKEN
-- dbt artifacts in target directory
-## Download Workflows
-The `recce-cloud download` command supports two workflows:
-### 1. Platform-Specific Workflow (Recommended)
-**For GitHub Actions and GitLab CI**
-Automatically finds and downloads artifacts from Recce Cloud sessions using platform-specific APIs. No session ID required.
-**Features:**
-- ✅ Auto-detects PR/MR context
-- ✅ Supports downloading production/base session with `--prod` flag
-- ✅ Works with CI-provided tokens (GITHUB_TOKEN, CI_JOB_TOKEN)
-**Usage:**
-```bash
-# GitHub Actions - Download current PR session
-recce-cloud download
-# GitLab CI - Download current MR session
-recce-cloud download
-# Download production/base session
-recce-cloud download --prod
-# Download to custom target path
-recce-cloud download --target-path target-base
-# Force overwrite existing files
-recce-cloud download --force
-```
-**Requirements:**
-- Running in GitHub Actions or GitLab CI environment
-- CI-provided token (GITHUB_TOKEN/CI_JOB_TOKEN)
-- Session must exist in Recce Cloud
-### 2. Generic Workflow
-**For other CI platforms or specific sessions**
-Downloads from a specific Recce Cloud session using session ID.
-**Usage:**
-```bash
-# With session ID parameter
-recce-cloud download --session-id abc123
-# With environment variable
-export RECCE_SESSION_ID=abc123
-recce-cloud download
-# With custom target path
-recce-cloud download --session-id abc123 --target-path my-target
-# Force overwrite
-recce-cloud download --session-id abc123 --force
-```
-**Requirements:**
-- Session ID (from Recce Cloud web app or API)
-- RECCE_API_TOKEN
-- Session must exist in Recce Cloud
-## Command Reference
-### `recce-cloud login`
-Authenticate with Recce Cloud.
-**Options:**
-| Option    | Type   | Default | Description                                      |
-| --------- | ------ | ------- | ------------------------------------------------ |
-| `--token` | string | -       | API token for direct authentication (optional)   |
-**Usage:**
-```bash
-# Browser-based login (opens browser for OAuth)
-recce-cloud login
-# Direct token authentication (for CI/headless environments)
-recce-cloud login --token <your-api-token>
-```
-**Notes:**
-- Browser login opens Recce Cloud in your default browser for secure OAuth authentication
-- If the browser doesn't open automatically, the URL is displayed for manual access
-- Token-based login is useful for CI/CD environments or when browser access is unavailable
-- Credentials are saved to `~/.recce/profile.yml`
-### `recce-cloud logout`
-Clear stored Recce Cloud credentials.
-**Usage:**
-```bash
-recce-cloud logout
-```
-### `recce-cloud init`
-Initialize project binding to link a local project with a Recce Cloud organization and project.
-**Usage:**
-```bash
-recce-cloud init
-```
-**Workflow:**
-1. Verifies you are logged in (prompts for login if not)
-2. Lists available organizations (shows display names)
-3. Prompts you to select an organization
-4. Lists available projects in selected organization (excludes archived projects)
-5. Prompts you to select a project
-6. Saves binding to `.recce/config`
-7. Optionally adds `.recce/` to `.gitignore`
-**Notes:**
-- Requires authentication (run `recce-cloud login` first)
-- Creates `.recce/config` file in current directory
-- Binding can be overridden with environment variables (`RECCE_ORG`, `RECCE_PROJECT`)
-### `recce-cloud status`
-Display current authentication and project binding status.
-**Usage:**
-```bash
-recce-cloud status
-```
-**Output:**
-- Shows logged-in user email (or "Not logged in")
-- Shows current project binding (organization/project or "Not bound")
-- Indicates configuration source (CLI flags, environment variables, or local config)
-### `recce-cloud upload`
-Upload dbt artifacts to Recce Cloud session.
-**Options:**
-| Option          | Type    | Default  | Description                                   |
-| --------------- | ------- | -------- | --------------------------------------------- |
-| `--target-path` | path    | `target` | Path to dbt target directory                  |
-| `--session-id`  | string  | -        | Session ID for generic workflow (optional)    |
-| `--pr`          | integer | -        | Override PR/MR number                         |
-| `--type`        | choice  | -        | Override session type: `pr`, `prod`, `dev`    |
-| `--dry-run`     | flag    | false    | Show what would be uploaded without uploading |
-**Environment Variables:**
-| Variable           | Required      | Description                     |
-| ------------------ | ------------- | ------------------------------- |
-| `RECCE_API_TOKEN`  | Recommended   | Recce Cloud API token           |
-| `RECCE_SESSION_ID` | Optional      | Session ID for generic workflow |
-| `GITHUB_TOKEN`     | Explicit set  | GitHub authentication (Actions) |
-| `CI_JOB_TOKEN`     | Auto-detected | GitLab authentication (CI)      |
-**Exit Codes:**
-| Code | Description                                         |
-| ---- | --------------------------------------------------- |
-| 0    | Success                                             |
-| 1    | Platform not supported (platform-specific workflow) |
-| 2    | Authentication error                                |
-| 3    | File validation error                               |
-| 4    | Upload error                                        |
-### `recce-cloud download`
-Download dbt artifacts (manifest.json, catalog.json) from Recce Cloud session.
-**Options:**
-| Option          | Type   | Default  | Description                                          |
-| --------------- | ------ | -------- | ---------------------------------------------------- |
-| `--target-path` | path   | `target` | Path to directory where artifacts will be downloaded |
-| `--session-id`  | string | -        | Session ID for generic workflow (optional)           |
-| `--prod`        | flag   | false    | Download production/base session                     |
-| `--dry-run`     | flag   | false    | Show what would be downloaded without downloading    |
-| `--force`, `-f` | flag   | false    | Overwrite existing files without prompting           |
-**Environment Variables:**
-| Variable           | Required      | Description                     |
-| ------------------ | ------------- | ------------------------------- |
-| `RECCE_API_TOKEN`  | Recommended   | Recce Cloud API token           |
-| `RECCE_SESSION_ID` | Optional      | Session ID for generic workflow |
-| `GITHUB_TOKEN`     | Explicit set  | GitHub authentication (Actions) |
-| `CI_JOB_TOKEN`     | Auto-detected | GitLab authentication (CI)      |
-**Exit Codes:**
-| Code | Description                                         |
-| ---- | --------------------------------------------------- |
-| 0    | Success                                             |
-| 1    | Platform not supported (platform-specific workflow) |
-| 2    | Authentication error                                |
-| 3    | File validation error                               |
-| 4    | Download error                                      |
-**Common Examples:**
-```bash
-# Auto-find and download current PR/MR session
-recce-cloud download
-# Download project's production/base session
-recce-cloud download --prod
-# Download from specific session ID
-recce-cloud download --session-id abc123
-# Download prod session to target-base
-recce-cloud download --prod --target-path target-base
-# Force overwrite existing files
-recce-cloud download --force
-# Dry run - preview what would be downloaded
-recce-cloud download --dry-run
-```
-### `recce-cloud version`
-Display the version of recce-cloud.
-```bash
-recce-cloud version
-```
-## Authentication
-The CLI supports multiple authentication methods with the following priority:
-1. **RECCE_API_TOKEN** (explicit token) - Recommended for production
-2. **CI-provided tokens** - GITHUB_TOKEN (Actions) or CI_JOB_TOKEN (GitLab CI)
-3. Error if no token available
-### Getting API Tokens
-**Recce Cloud API Token:**
-1. Log in to [Recce Cloud](https://cloud.datarecce.io)
-2. Go to Settings → API Tokens
-3. Create a new token
-4. Add to CI/CD secrets as `RECCE_API_TOKEN`
-**GitHub Token:**
-- Available as `${{ secrets.GITHUB_TOKEN }}` in Actions
-- Must be explicitly set in `env:` section of your workflow
-**GitLab Token:**
-- Automatically available as `$CI_JOB_TOKEN` in GitLab CI
-- No additional configuration needed
-## Auto-Detection
-The CLI automatically detects your CI environment:
-### Detected Information
-| Information   | GitHub Actions        | GitLab CI                                |
-| ------------- | --------------------- | ---------------------------------------- |
-| Platform      | ✅ `github-actions`   | ✅ `gitlab-ci`                           |
-| Repository    | ✅ `owner/repo`       | ✅ `group/project`                       |
-| PR/MR Number  | ✅ From event payload | ✅ From `CI_MERGE_REQUEST_IID`           |
-| PR/MR URL     | ✅ Constructed        | ✅ Constructed (self-hosted support)     |
-| Commit SHA    | ✅ `GITHUB_SHA`       | ✅ `CI_COMMIT_SHA`                       |
-| Source Branch | ✅ `GITHUB_HEAD_REF`  | ✅ `CI_MERGE_REQUEST_SOURCE_BRANCH_NAME` |
-| Base Branch   | ✅ `GITHUB_BASE_REF`  | ✅ `CI_MERGE_REQUEST_TARGET_BRANCH_NAME` |
-| Session Type  | ✅ Auto-determined    | ✅ Auto-determined                       |
-| Access Token  | ✅ `GITHUB_TOKEN`     | ✅ `CI_JOB_TOKEN`                        |
-### Manual Overrides
-You can override auto-detected values:
-```bash
-# Override PR/MR number
-recce-cloud upload --pr 456
-# Override session type
-recce-cloud upload --type prod
-# Multiple overrides
-recce-cloud upload --pr 789 --type pr
-# Dry run - preview what would be uploaded
-recce-cloud upload --dry-run
-```
-## CI/CD Integration Examples
-### GitHub Actions - Upload Workflow
-```yaml
-name: Recce CI - Upload
-on:
-  pull_request:
-    branches: [main]
-jobs:
-  recce:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.11"
-      - name: Install dependencies
-        run: |
-          pip install dbt-core dbt-postgres recce-cloud
-      - name: Build dbt project
-        run: |
-          dbt deps
-          dbt build
-          dbt docs generate
-      - name: Upload to Recce Cloud
-        run: recce-cloud upload
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-### GitHub Actions - Download Workflow
-```yaml
-name: Recce CI - Download
-on:
-  pull_request:
-    branches: [main]
-jobs:
-  recce:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.11"
-      - name: Install dependencies
-        run: |
-          pip install dbt-core dbt-postgres recce-cloud
-      # Download production/base artifacts
-      - name: Download base artifacts from Recce Cloud
-        run: recce-cloud download --prod --target-path target-base
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      # Build current PR version
-      - name: Build dbt project (current)
-        run: |
-          dbt deps
-          dbt build
-          dbt docs generate
-      # Upload current PR artifacts
-      - name: Upload to Recce Cloud
-        run: recce-cloud upload
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-### GitLab CI - Upload Workflow
-```yaml
-stages:
-  - build
-  - upload
-dbt-build:
-  stage: build
-  image: python:3.11-slim
-  script:
-    - pip install dbt-core dbt-postgres
-    - dbt deps
-    - dbt build
-    - dbt docs generate
-  artifacts:
-    paths:
-      - target/
-recce-upload:
-  stage: upload
-  image: python:3.11-slim
-  script:
-    - pip install recce-cloud
-    - recce-cloud upload
-  dependencies:
-    - dbt-build
-  only:
-    - merge_requests
-    - main
-```
-### GitLab CI - Download Workflow
-```yaml
-stages:
-  - download
-  - build
-  - upload
-recce-download-base:
-  stage: download
-  image: python:3.11-slim
-  script:
-    - pip install recce-cloud
-    - recce-cloud download --prod --target-path target-base
-  artifacts:
-    paths:
-      - target-base/
-  only:
-    - merge_requests
-dbt-build:
-  stage: build
-  image: python:3.11-slim
-  script:
-    - pip install dbt-core dbt-postgres
-    - dbt deps
-    - dbt build
-    - dbt docs generate
-  artifacts:
-    paths:
-      - target/
-  only:
-    - merge_requests
-recce-upload:
-  stage: upload
-  image: python:3.11-slim
-  script:
-    - pip install recce-cloud
-    - recce-cloud upload
-  dependencies:
-    - dbt-build
-  only:
-    - merge_requests
-```
-### Generic CI Platform
-For other CI platforms, use the generic workflow with session ID:
-```yaml
-# Upload
-- name: Upload to Recce Cloud
-  script:
-    - pip install recce-cloud
-    - recce-cloud upload --session-id ${SESSION_ID}
-  environment:
-    RECCE_API_TOKEN: ${RECCE_API_TOKEN}
-    SESSION_ID: ${SESSION_ID}
-# Download
-- name: Download from Recce Cloud
-  script:
-    - pip install recce-cloud
-    - recce-cloud download --session-id ${SESSION_ID}
-  environment:
-    RECCE_API_TOKEN: ${RECCE_API_TOKEN}
-    SESSION_ID: ${SESSION_ID}
-```
-## Troubleshooting
-### Common Issues
-**1. Missing dbt artifacts**
-```
-Error: Invalid target path: target
-Please provide a valid target path containing manifest.json and catalog.json.
-```
-**Solution:** Ensure `dbt docs generate` has been run successfully before upload.
-```bash
-dbt build
-dbt docs generate  # Required!
-recce-cloud upload
-```
-**2. Authentication failed**
-```
-Error: No authentication token provided
-Set RECCE_API_TOKEN environment variable or ensure CI token is available
-```
-**Solution:** Token requirements depend on your workflow type:
-**For Generic Workflow (with `--session-id`):**
-- Always requires explicit `RECCE_API_TOKEN`
-```bash
-# Set token and use session ID
-export RECCE_API_TOKEN=your_token_here
-recce-cloud upload --session-id abc123
-recce-cloud download --session-id abc123
-```
-**For Platform-Specific Workflow:**
-_GitHub CI_
-- Use `GITHUB_TOKEN` (explicitly set)
-```yaml
-env:
-  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-**3. Platform not supported**
-```
-Error: Platform-specific upload requires GitHub Actions or GitLab CI environment
-Detected platform: unknown
-```
-**Solution:** Use generic workflow with session ID, or run in supported CI platform.
-```bash
-recce-cloud upload --session-id abc123
-```
-**4. Session not found**
-```
-Error: Session ID abc123 does not belong to any organization.
-```
-**Solution:** Verify session ID is correct and accessible with your API token.
-**5. GitLab self-hosted instance**
-The CLI automatically detects self-hosted GitLab instances using `CI_SERVER_URL`.
-```yaml
-# No additional configuration needed
-recce-upload:
-  script:
-    - recce-cloud upload
-```
-**6. Target path already exists (download)**
-```
-Error: Target path already exists: target
-Use --force to overwrite existing directory
-```
-**Solution:** Use `--force` flag to overwrite existing files, or choose a different target path.
-```bash
-recce-cloud download --force
-# OR
-recce-cloud download --target-path target-new
-```
-**7. No production session available**
-```
-Error: No production session found for this project
-```
-**Solution:** Upload a production session first, or use a specific session ID.
-```bash
-# Upload production session (on main branch)
-recce-cloud upload --type prod
-# Or download from specific session
-recce-cloud download --session-id abc123
-```
-### Debug Mode
-Enable verbose logging for troubleshooting:
-```bash
-# Set log level to DEBUG
-export RECCE_LOG_LEVEL=DEBUG
-recce-cloud upload
-```
-## Architecture
-### Platform-Specific APIs
-The CLI uses platform-specific API endpoints for auto-session creation:
-**GitHub Actions:**
-- `POST /api/v2/github/{repository}/touch-recce-session`
-- `POST /api/v2/github/{repository}/upload-completed`
-**GitLab CI:**
-- `POST /api/v2/gitlab/{project_path}/touch-recce-session`
-- `POST /api/v2/gitlab/{project_path}/upload-completed`
-### Upload Process
-**Platform-Specific Workflow:**
-1. Detect CI platform and extract context
-2. Validate dbt artifacts
-3. Extract adapter type from manifest
-4. Authenticate with Recce Cloud API
-5. Call `touch-recce-session` (creates or updates session)
-6. Upload manifest.json to presigned S3 URL
-7. Upload catalog.json to presigned S3 URL
-8. Call `upload-completed` (notifies Recce Cloud)
-**Generic Workflow:**
-1. Detect CI platform (optional)
-2. Validate dbt artifacts
-3. Extract adapter type from manifest
-4. Authenticate with Recce Cloud API
-5. Get session info (org_id, project_id)
-6. Get presigned upload URLs
-7. Upload manifest.json to S3
-8. Upload catalog.json to S3
-9. Update session metadata
-### Download Process
-**Platform-Specific Workflow:**
-1. Detect CI platform and extract context
-2. Authenticate with Recce Cloud API
-3. Call download API with PR/MR context
-4. Get presigned download URLs and session ID
-5. Create target directory (if needed)
-6. Download manifest.json from S3
-7. Download catalog.json from S3
-**Generic Workflow (Session ID):**
-1. Authenticate with Recce Cloud API
-2. Get session info (org_id, project_id)
-3. Get presigned download URLs by session ID
-4. Create target directory (if needed)
-5. Download manifest.json from S3
-6. Download catalog.json from S3
-## Development
-### Running Tests
-```bash
-# Install development dependencies
-pip install -e .[dev]
-# Run tests
-pytest tests/recce_cloud/
-# Run with coverage
-pytest --cov=recce_cloud --cov-report=html tests/recce_cloud/
-# Run specific test file
-pytest tests/recce_cloud/test_platform_clients.py
-```
-### Code Quality
-```bash
-# Format code
-make format
-# Run quality checks
-make check
-# Run all checks and tests
-make test
-```
-## Support
-- **Documentation:** [docs.reccehq.com](https://docs.reccehq.com)
-- **Issues:** [GitHub Issues](https://github.com/DataRecce/recce/issues)
-- **Community:** [Recce Slack](https://getdbt.slack.com/archives/C05C28V7CPP)
-- **Email:** <support@reccehq.com>
-## License
-Apache License 2.0 - See [LICENSE](../LICENSE) file for details.

{recce_cloud-1.34.0.dist-info → recce_cloud-1.35.0.dist-info}/WHEEL RENAMED Viewed

File without changes

recce-cloud 1.34.0__py3-none-any.whl → 1.35.0__py3-none-any.whl

recce-cloud 1.34.0py3-none-any.whl → 1.35.0py3-none-any.whl