@datarecce/ui 0.1.41 → 0.2.0

package/recce-source/RECCE_CLOUD.md

@@ -1,81 +0,0 @@
-# Recce Cloud CLI
-
-A lightweight, standalone CLI for managing Recce Cloud operations in CI/CD environments.
-
-## Overview
-
-The `recce-cloud` package provides a minimal CLI tool specifically designed for cloud operations, without the heavy dependencies of the full `recce` package. This makes it ideal for CI/CD pipelines where installation speed matters.
-
-## Dependency Comparison
-
-**recce-cloud** (3 dependencies):
-- click
-- requests
-- rich
-
-**recce** (20+ dependencies):
-- boto3, click, deepdiff, fastapi, GitPython, itsdangerous, jinja2, packaging, portalocker, py-markdown-table, pydantic, PyGithub, python-dateutil, python-multipart, pytz, requests, rich, ruamel.yaml, sentry-sdk, sqlglot, uvicorn, watchdog, websockets
-
-## Installation
-
-### Development Mode
-
-From the repository root:
-
-```bash
-python setup_cloud.py develop
-```
-
-### Production Install (when published to PyPI)
-
-```bash
-pip install recce-cloud
-```
-
-## Usage
-
-```bash
-# Check version
-recce-cloud --version
-
-# Get help
-recce-cloud --help
-```
-
-## Package Structure
-
-```
-recce_cloud/
-├── __init__.py          # Package initialization and version
-├── cli.py              # Main CLI entry point
-└── VERSION             # Version file (synced with main recce)
-```
-
-## CI/CD Integration Example
-
-```yaml
-# GitHub Actions example
-- name: Install recce-cloud
-  run: pip install recce-cloud
-
-- name: Use recce-cloud
-  run: recce-cloud --version
-```
-
-## Development
-
-The `recce-cloud` package is developed within the same repository as `recce` but is packaged and distributed separately:
-
-- **Main package**: `setup.py` → installs `recce` command
-- **Cloud package**: `setup_cloud.py` → installs `recce-cloud` command
-
-Both packages share the same VERSION file to keep versions synchronized.
-
-## Future Commands
-
-The CLI is designed to be extended with cloud-specific commands such as:
-- `recce-cloud list-sessions` - List Recce Cloud sessions
-- `recce-cloud purge` - Purge cloud state files
-- `recce-cloud upload` - Upload state files to cloud
-
-Currently, only the basic CLI structure with version command is implemented.

package/recce-source/SECURITY.md

@@ -1,25 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 0.x     | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-Please report (suspected) security vulnerabilities to **dev@infuseai.io**. You will receive a response from us within 48 hours. In the response, we will confirm whether the vulnerability was indeed found, and we will discuss the steps towards a solution.
-
-It's important to never publicly disclose a security vulnerability before it has been fully resolved, as this can potentially put the wider community at risk.
-
-### Security Vulnerability Response
-
-* Acknowledgement of receipt of the report
-* Regular updates about the progress towards fixing the vulnerability
-* An announced release date for the patch fixing the vulnerability
-
-### Public Disclosure Timing
-
-After the initial reply to your report, we will keep you informed of the progress towards a fix and full announcement. We aim to handle all security vulnerabilities in a timely manner. After the vulnerability has been fixed, we will publish a security advisory along with credit to the reporter if desired.
-
-Thank you for helping to keep Recce and its users safe!

package/recce-source/docs/PACKAGING.md

@@ -1,340 +0,0 @@
-# Recce Packaging Guide
-
-This document explains how `recce` and `recce-cloud` packages are structured, built, and published.
-
-## Overview
-
-The Recce repository contains two separate Python packages:
-
-1. **`recce`** - Full-featured CLI for local development and review
-2. **`recce-cloud`** - Lightweight CLI for CI/CD environments
-
-Both packages share the same version number from `recce/VERSION`.
-
-## Package Structure
-
-```
-recce/
-├── recce/                    # Main package (full-featured)
-│   ├── VERSION              # Single source of truth for both packages
-│   └── ...
-├── recce_cloud/             # Lightweight cloud package
-│   ├── VERSION              # Synced from recce/VERSION during build
-│   ├── __init__.py          # Reads VERSION with fallback
-│   └── ...
-├── setup.py                 # Build config for 'recce' package
-├── setup_cloud.py           # Build config for 'recce-cloud' package
-├── pyproject.toml           # Modern Python build system config
-└── Makefile                 # Build automation
-```
-
-## Version Management
-
-### Single Source of Truth
-
-All version information comes from `recce/VERSION`:
-
-```
-1.24.0
-```
-
-### How Versioning Works
-
-1. **Build time**: `setup.py` and `setup_cloud.py` read `recce/VERSION`
-2. **Build process**: `make build-cloud` copies `recce/VERSION` to `recce_cloud/VERSION`
-3. **Runtime**: `recce_cloud/__init__.py` reads VERSION with fallback logic:
-   - First tries `recce_cloud/VERSION` (for installed package)
-   - Falls back to `../recce/VERSION` (for development)
-
-### Updating Version
-
-To release a new version:
-
-```bash
-# 1. Update the version file
-echo "1.25.0" > recce/VERSION
-
-# 2. Commit the change
-git add recce/VERSION
-git commit -m "chore: bump version to 1.25.0"
-
-# 3. Tag the release
-git tag v1.25.0
-git push && git push --tags
-```
-
-## Development Workflow
-
-### Installing for Development
-
-**Install recce (full package):**
-```bash
-make install-dev
-# OR
-pip install -e .[dev]
-```
-
-**Install recce-cloud (lightweight package):**
-```bash
-make install-cloud-dev
-# OR
-cd /path/to/recce
-python setup_cloud.py develop
-```
-
-**Install both packages:**
-```bash
-make install-dev
-make install-cloud-dev
-```
-
-### Running Tests
-
-```bash
-# Test recce
-make test
-
-# Test recce-cloud
-pytest tests/recce_cloud/
-
-# Test with coverage
-make test-coverage
-```
-
-### Code Quality
-
-```bash
-# Format code (both packages)
-make format
-make format-cloud
-
-# Check code quality (both packages)
-make check
-make check-cloud
-
-# Lint (both packages)
-make flake8
-make flake8-cloud
-```
-
-## Build Process
-
-### Building Packages
-
-**Build recce only:**
-```bash
-make build
-```
-This will:
-1. Clean build artifacts
-2. Build frontend (pnpm install + pnpm build)
-3. Build Python package (python setup.py sdist bdist_wheel)
-
-**Build recce-cloud only:**
-```bash
-make build-cloud
-```
-This will:
-1. Clean build artifacts
-2. Sync VERSION file to recce_cloud/
-3. Build Python package (python setup_cloud.py sdist bdist_wheel)
-
-**Build both packages:**
-```bash
-make build-all
-```
-This will:
-1. Clean build artifacts
-2. Build frontend
-3. Build both recce and recce-cloud packages
-
-**Build frontend only:**
-```bash
-make build-frontend
-```
-
-**Clean build artifacts:**
-```bash
-make clean-build
-```
-
-This creates packages in `dist/`:
-- `recce-1.24.0.tar.gz` (source distribution)
-- `recce-1.24.0-py3-none-any.whl` (wheel)
-- `recce-cloud-1.24.0.tar.gz` (source distribution)
-- `recce_cloud-1.24.0-py3-none-any.whl` (wheel)
-
-## Publishing to PyPI
-
-### Prerequisites
-
-1. Install publishing tools:
-   ```bash
-   pip install twine
-   ```
-
-2. Configure PyPI credentials:
-   ```bash
-   # Create ~/.pypirc with:
-   [pypi]
-   username = __token__
-   password = pypi-<your-token>
-   ```
-
-### Publishing Workflow
-
-**1. Build both packages:**
-```bash
-make build-all
-```
-
-**2. Check packages:**
-```bash
-twine check dist/*
-```
-
-**3. Upload to TestPyPI (optional):**
-```bash
-twine upload --repository testpypi dist/*
-```
-
-**4. Upload to PyPI:**
-```bash
-# Upload recce-cloud first
-twine upload dist/recce-cloud-*
-
-# Then upload recce
-twine upload dist/recce-*
-```
-
-**Note:** Always publish `recce-cloud` before `recce` to ensure the dependency is available.
-
-### Future: Add recce → recce-cloud Dependency
-
-When ready, update `setup.py`:
-
-```python
-install_requires=[
-    "recce-cloud",  # Add this line
-    "boto3",
-    # ... other deps
-]
-```
-
-This makes `pip install recce` automatically install `recce-cloud`.
-
-## Installation Scenarios
-
-### Scenario 1: Lightweight (CI/CD)
-
-```bash
-pip install recce-cloud
-```
-
-**Result:**
-- Only `recce-cloud` installed
-- 3 dependencies (click, requests, rich)
-- ~5MB installed size
-- Only `recce-cloud` command available
-
-### Scenario 2: Full (Development)
-
-```bash
-pip install recce
-```
-
-**Result:**
-- Only `recce` installed (currently)
-- 20+ dependencies
-- ~50MB+ installed size
-- Only `recce` command available
-
-**Future (when dependency added):**
-- Both `recce` and `recce-cloud` installed
-- `recce-cloud` downloaded automatically from PyPI
-- Both commands available
-
-## Troubleshooting
-
-### VERSION file not found
-
-**Error:**
-```
-FileNotFoundError: [Errno 2] No such file or directory: 'VERSION'
-```
-
-**Solution:**
-Ensure you're running build commands from the repository root, or use Makefile targets.
-
-### recce-cloud command not found after install
-
-**Cause:** Package not installed correctly or not in PATH
-
-**Solution:**
-```bash
-# Verify installation
-pip show recce-cloud
-
-# Check entry point
-pip show -f recce-cloud | grep recce-cloud
-
-# Reinstall
-pip uninstall recce-cloud
-pip install recce-cloud
-```
-
-### Development install doesn't work
-
-**Issue:** `python setup_cloud.py develop` fails with path errors
-
-**Solution:**
-Run from repository root:
-```bash
-cd /path/to/recce
-python setup_cloud.py develop
-```
-
-Or use Makefile:
-```bash
-make install-cloud-dev
-```
-
-## Reference
-
-### Makefile Targets
-
-| Command | Description |
-|---------|-------------|
-| `make install` | Install recce package |
-| `make install-dev` | Install recce with dev dependencies |
-| `make install-cloud` | Install recce-cloud package |
-| `make install-cloud-dev` | Install recce-cloud in development mode |
-| `make build` | Build recce package |
-| `make build-cloud` | Build recce-cloud package |
-| `make build-all` | Build both packages |
-| `make clean-build` | Clean build artifacts |
-| `make test` | Run tests |
-| `make format` | Format code (recce) |
-| `make format-cloud` | Format code (recce-cloud) |
-| `make check` | Check code quality (recce) |
-| `make check-cloud` | Check code quality (recce-cloud) |
-
-### Package Dependencies
-
-**recce-cloud:**
-- `click>=7.1`
-- `requests>=2.28.1`
-- `rich>=12.0.0`
-
-**recce:**
-- All recce-cloud dependencies (when dependency added)
-- Plus: boto3, fastapi, uvicorn, pydantic, dbt, etc.
-
-## Best Practices
-
-1. **Always build both packages together** using `make build-all`
-2. **Test installation** in a clean virtual environment before publishing
-3. **Publish recce-cloud first** to ensure dependency is available
-4. **Use Makefile targets** for consistent builds
-5. **Keep VERSION in sync** by only editing `recce/VERSION`
-6. **Run tests** before publishing: `make test && pytest tests/recce_cloud/`

package/recce-source/docs/README.md

@@ -1 +0,0 @@
-Please check the [Recce documentation](https://datarecce.io/docs/)

package/recce-source/docs/plans/2024-12-31-csv-download-design.md

@@ -1,121 +0,0 @@
-# CSV Download Feature Design
-
-## Overview
-
-Add CSV export capabilities to the Run Result pane, refactoring the existing "Copy to Clipboard" button into a menu with multiple export options.
-
-## Requirements
-
-- Refactor "Copy to Clipboard" button into a dropdown menu
-- Rename screenshot functionality to "Copy as Image"
-- Add "Copy as CSV" option (copies CSV text to clipboard)
-- Add "Download as CSV" option (downloads CSV file)
-- Support all tabular result types
-- Excel-friendly CSV format with UTF-8 BOM
-- Context-aware filenames with timestamps
-
-## Menu Structure
-
-```
-┌─────────────────────┐
-│ Copy as Image       │  ← renamed from "Copy to Clipboard"
-│ Copy as CSV         │  ← new (disabled if not tabular)
-│ Download as CSV     │  ← new (disabled if not tabular)
-├─────────────────────┤
-│ Share to Cloud      │  ← existing (only if share enabled)
-└─────────────────────┘
-```
-
-Button label remains "Share" for consistency.
-
-## New Files
-
-### `js/src/lib/csv.ts`
-
-CSV utility functions:
-
-```typescript
-// Convert tabular data to CSV string (Excel-friendly with BOM)
-export function toCSV(columns: string[], rows: unknown[][]): string
-
-// Trigger browser download of CSV file
-export function downloadCSV(content: string, filename: string): void
-
-// Copy CSV content to clipboard
-export function copyCSVToClipboard(content: string): Promise<void>
-```
-
-CSV formatting rules:
-- UTF-8 BOM prefix (`\uFEFF`) for Excel compatibility
-- Values containing commas, quotes, or newlines wrapped in double-quotes
-- Double-quotes escaped as `""`
-- NULL values exported as empty string
-- Numbers exported without locale formatting (raw values)
-- Booleans as `true`/`false`
-
-### `js/src/lib/csvExtractors.ts`
-
-Data extraction functions per result type:
-
-```typescript
-interface CSVData {
-  columns: string[];
-  rows: unknown[][];
-}
-
-// Returns CSVData or null if not supported
-export function extractCSVData(runType: string, result: unknown): CSVData | null
-```
-
-## Supported Result Types
-
-| Run Type | Data Location | Columns | Rows |
-|----------|---------------|---------|------|
-| `query` | `result.base` or `result.current` | `result.*.columns[].name` | `result.*.data` |
-| `query_diff` | `result.base` + `result.current` | merged columns | merged rows with base/current markers |
-| `query_base` | `result.base` | `result.base.columns[].name` | `result.base.data` |
-| `profile` | `result.base` + `result.current` | profile metrics as columns | one row per column profiled |
-| `row_count` | `result` | `[node, base_count, current_count, diff]` | one row per node |
-| `value_diff` | `result` | value columns | diff rows |
-| `top_k` | `result` | category + count columns | top-k rows |
-
-## Filename Generation
-
-Format: `{runType}-{nodeName}-{timestamp}.csv`
-
-Timestamp format: `YYYYMMDD-HHmmss` (compact, sortable, filesystem-safe)
-
-Examples:
-- `query-diff-orders-20241231-143022.csv`
-- `profile-customers-20241231-143022.csv`
-- `row-count-20241231-143022.csv`
-- `query-result-20241231-143022.csv` (fallback when no node name)
-
-## Component Changes
-
-### `RunResultPane.tsx`
-
-Update `RunResultShareMenu` component:
-- Rename "Copy to Clipboard" → "Copy as Image"
-- Add "Copy as CSV" menu item
-- Add "Download as CSV" menu item
-- Pass `run` object to menu for data extraction
-- Disable CSV options when `extractCSVData()` returns null
-
-Standalone button case (when `featureToggles.disableShare` is true):
-- Convert single button into dropdown menu
-- Same options minus "Share to Cloud"
-
-### Menu Item Disabled States
-
-| Option | Disabled when |
-|--------|---------------|
-| Copy as Image | No result, error, or not on "Result" tab |
-| Copy as CSV | Above + result type not tabular |
-| Download as CSV | Above + result type not tabular |
-| Share to Cloud | No result or error |
-
-## User Feedback
-
-- Toast notification on success: "Copied to clipboard", "Downloaded {filename}"
-- Toast notification on error: "Failed to copy", "Failed to download"