pointblank 0.10.0__tar.gz → 0.11.0__tar.gz

{pointblank-0.10.0 → pointblank-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pointblank
-Version: 0.10.0
+Version: 0.11.0
 Summary: Find out if your data is what you think it is.
 Author-email: Richard Iannone <riannone@me.com>
 License: MIT License
@@ -46,6 +46,8 @@ Requires-Dist: great_tables>=0.17.0
 Requires-Dist: narwhals>=1.41.0
 Requires-Dist: typing_extensions>=3.10.0.0
 Requires-Dist: requests>=2.31.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
 Provides-Extra: pd
 Requires-Dist: pandas>=2.2.3; extra == "pd"
 Provides-Extra: pl
@@ -233,6 +235,49 @@ validation.get_step_report(i=3).show("browser")  # Get failing records from step
 
 <br>
 
+## Command Line Interface (CLI)
+
+Pointblank includes a powerful CLI utility called `pb` that lets you run data validation workflows directly from the command line. Perfect for CI/CD pipelines, scheduled data quality checks, or quick validation tasks.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**Explore Your Data**
+
+```bash
+# Get a quick preview of your data
+pb preview small_table
+
+# Check for missing values
+pb missing small_table
+
+# Generate column summaries
+pb scan small_table
+```
+
+**Run Essential Validations**
+
+```bash
+# Check for duplicate rows
+pb validate-simple small_table --check rows-distinct
+
+# Verify no null values
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extract failing data for debugging
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integrate with CI/CD**
+
+```bash
+# Use exit codes for automation (0 = pass, 1 = fail)
+pb validate-simple small_table --check rows-distinct && echo "✅ Quality checks passed"
+```
+
+Learn more in our [CLI documentation](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Features That Set Pointblank Apart
 
 - **Complete validation workflow** - From data access to validation to reporting in a single pipeline

{pointblank-0.10.0 → pointblank-0.11.0}/README.md

@@ -149,6 +149,49 @@ validation.get_step_report(i=3).show("browser")  # Get failing records from step
 
 <br>
 
+## Command Line Interface (CLI)
+
+Pointblank includes a powerful CLI utility called `pb` that lets you run data validation workflows directly from the command line. Perfect for CI/CD pipelines, scheduled data quality checks, or quick validation tasks.
+
+<div align="center">
+<img src="https://posit-dev.github.io/pointblank/assets/vhs/cli-complete-workflow.gif" width="800px">
+</div>
+
+**Explore Your Data**
+
+```bash
+# Get a quick preview of your data
+pb preview small_table
+
+# Check for missing values
+pb missing small_table
+
+# Generate column summaries
+pb scan small_table
+```
+
+**Run Essential Validations**
+
+```bash
+# Check for duplicate rows
+pb validate-simple small_table --check rows-distinct
+
+# Verify no null values
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extract failing data for debugging
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integrate with CI/CD**
+
+```bash
+# Use exit codes for automation (0 = pass, 1 = fail)
+pb validate-simple small_table --check rows-distinct && echo "✅ Quality checks passed"
+```
+
+Learn more in our [CLI documentation](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Features That Set Pointblank Apart
 
 - **Complete validation workflow** - From data access to validation to reporting in a single pipeline

{pointblank-0.10.0 → pointblank-0.11.0}/docs/_quarto.yml

@@ -1,6 +1,8 @@
 project:
   type: website
   post-render: scripts/post-render.py
+  resources:
+    - "assets/**"
 
 format:
   html:
@@ -61,6 +63,7 @@ website:
           contents:
             - user-guide/index.qmd
             - user-guide/installation.qmd
+            - user-guide/cli.qmd
         - section: "Validation Plan"
           contents:
             - user-guide/validation-overview.qmd

pointblank-0.11.0/docs/assets/vhs/cli-cicd-workflows.tape

@@ -0,0 +1,51 @@
+# VHS tape for CI/CD integration workflows
+# Shows production-ready automation patterns
+
+Output cli-cicd-workflows.gif
+
+Set FontSize 16
+Set Width 1200
+Set Height 700
+Set Theme "Dracula"
+
+Type "# Production CI/CD Data Validation Workflows"
+Enter
+Sleep 1s
+
+Type ""
+Enter
+Type "# Pipeline Step 1: Data integrity check with exit codes"
+Enter
+Type "pb validate-simple small_table --check rows-distinct --exit-code"
+Enter
+Type "echo 'Pipeline result:' \$?"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "# Pipeline Step 2: Critical columns validation"
+Enter
+Type "pb validate-simple small_table --check col-vals-not-null --column date_time --exit-code"
+Enter
+Type "echo 'Validation status:' \$?"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "# Pipeline Step 3: Business rules validation"
+Enter
+Type "pb validate-simple small_table --check col-vals-gt --column a --value 0 --exit-code"
+Enter
+Type "echo 'Business rule check:' \$?"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "# Use in GitHub Actions, GitLab CI, or any automation platform"
+Enter
+Type "echo 'Exit codes: 0 = success, 1 = validation failed'"
+Enter
+Sleep 2s

pointblank-0.11.0/docs/assets/vhs/cli-complete-workflow.tape

@@ -0,0 +1,59 @@
+# VHS tape for complete validation workflow
+# Shows realistic end-to-end data quality checking
+
+Output cli-complete-workflow.gif
+
+Set FontSize 14
+Set Width 1200
+Set Height 900
+Set Theme "Dracula"
+
+Type "# Complete Data Quality Workflow"
+Enter
+Sleep 1s
+
+Type ""
+Enter
+Type "# Step 1: Explore your data first"
+Enter
+Type "pb preview small_table"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "# Step 2: Check for basic data integrity"
+Enter
+Type "pb validate-simple small_table --check rows-distinct"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "# Step 3: Validate critical business columns"
+Enter
+Type "pb validate-simple small_table --check col-vals-not-null --column a --show-extract"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# Step 4: Check data ranges and constraints"
+Enter
+Type "pb validate-simple small_table --check col-vals-in-set --column f --set 'low,mid,high'"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "# Step 5: Comprehensive data profiling"
+Enter
+Type "pb scan small_table"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "echo 'Full data quality pipeline complete!'"
+Enter
+Sleep 2s

pointblank-0.11.0/docs/assets/vhs/cli-data-exploration.tape

@@ -0,0 +1,43 @@
+# VHS tape for data exploration and profiling
+# Shows preview, missing values, and column summaries
+
+Output cli-data-exploration.gif
+
+Set FontSize 14
+Set Width 1200
+Set Height 800
+Set Theme "Dracula"
+
+Type "# Data Exploration & Profiling with Pointblank CLI"
+Enter
+Sleep 1s
+
+Type ""
+Enter
+Type "# 1. Quick data preview - see structure and sample rows"
+Enter
+Type "pb preview small_table"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# 2. Missing values analysis - identify data gaps"
+Enter
+Type "pb missing small_table"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# 3. Comprehensive data scan - statistical overview"
+Enter
+Type "pb scan small_table"
+Enter
+Sleep 5s
+
+Type ""
+Enter
+Type "echo 'Complete data profiling in seconds - no Python required!'"
+Enter
+Sleep 2s

pointblank-0.11.0/docs/assets/vhs/cli-essential-validations.tape

@@ -0,0 +1,43 @@
+# VHS tape for high-impact data validation demonstrations
+# Shows the most practical CLI validations
+
+Output cli-essential-validations.gif
+
+Set FontSize 16
+Set Width 1200
+Set Height 700
+Set Theme "Dracula"
+
+Type "# Essential Data Validation with Pointblank CLI"
+Enter
+Sleep 1s
+
+Type ""
+Enter
+Type "# 1. Check for duplicate rows (most common data quality issue)"
+Enter
+Type "pb validate-simple small_table --check rows-distinct"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# 2. Find missing values in critical columns"
+Enter
+Type "pb validate-simple small_table --check col-vals-not-null --column a"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# 3. When validation fails, see exactly which rows are problematic"
+Enter
+Type "pb validate-simple small_table --check col-vals-not-null --column b --show-extract"
+Enter
+Sleep 5s
+
+Type ""
+Enter
+Type "echo 'Essential validations: duplicates, nulls, with data extracts'"
+Enter
+Sleep 2s

pointblank-0.11.0/docs/assets/vhs/cli-getting-started.tape

@@ -0,0 +1,43 @@
+# VHS tape for CLI overview and getting started
+# Shows help and basic commands with custom prompt
+
+Output cli-getting-started.gif
+
+Set FontSize 16
+Set Width 1200
+Set Height 700
+Set Theme "Dracula"
+
+Type "# Getting Started with Pointblank CLI"
+Enter
+Sleep 1s
+
+Type ""
+Enter
+Type "# See all available commands"
+Enter
+Type "pb --help"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# Quick validation options overview"
+Enter
+Type "pb validate-simple --help"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# Your first validation - check for duplicates"
+Enter
+Type "pb validate-simple small_table --check rows-distinct"
+Enter
+Sleep 3s
+
+Type ""
+Enter
+Type "echo 'Ready to validate any dataset - CSV, Parquet, or database!'"
+Enter
+Sleep 2s

pointblank-0.11.0/docs/demos/cli-interactive/index.qmd

@@ -0,0 +1,141 @@
+---
+title: "CLI Interactive Demos"
+pagetitle: "CLI Interactive Demos"
+format:
+  html:
+    toc: true
+    css: |
+      .demo-section {
+        margin-bottom: 40px;
+      }
+      .gif-container {
+        margin: 20px 0;
+        text-align: center;
+        border: 1px solid #e1e5e9;
+        border-radius: 8px;
+        padding: 20px;
+        background: #f8f9fa;
+      }
+      .gif-container img {
+        max-width: 100%;
+        border-radius: 4px;
+        box-shadow: 0 4px 8px rgba(0,0,0,0.1);
+      }
+---
+
+# Command Line Interface: Interactive Demos
+
+These CLI demos showcase practical data quality workflows that you can use!
+
+::: {.callout-tip}
+## 🎬 Workflow-Based Demonstrations
+- **Essential validations** for everyday data quality checks
+- **Data exploration** tools that require no Python knowledge
+- **CI/CD integration** patterns for automated data quality
+- **Complete pipelines** from exploration to production validation
+:::
+
+::: {.callout-note}
+## Prerequisites
+To follow along with these demonstrations:
+```bash
+pip install pointblank
+pb --help  # Verify installation
+```
+:::
+
+### Getting Started with the CLI
+
+Learn the basics of Pointblank's CLI and run your first validation:
+
+::: {.gif-container}
+![Getting Started](../../assets/vhs/cli-getting-started.gif)
+*CLI overview and your first data quality validation*
+:::
+
+### Essential Data Quality Validations
+
+See the most commonly used validation checks that catch critical data issues:
+
+::: {.gif-container}
+![Essential Validations](../../assets/vhs/cli-essential-validations.gif)
+*Duplicate detection, null checks, and data extract debugging*
+:::
+
+### Data Exploration Without Python
+
+Discover how to profile and explore data using CLI tools that don't require Python knowledge:
+
+::: {.gif-container}
+![Data Exploration](../../assets/vhs/cli-data-exploration.gif)
+*Preview data, find missing values, and generate column summaries*
+:::
+
+### CI/CD Integration & Automation
+
+Learn how to integrate data quality checks into automated pipelines:
+
+::: {.gif-container}
+![CI/CD Integration](../../assets/vhs/cli-cicd-workflows.gif)
+*Exit codes, pipeline integration, and automated quality gates*
+:::
+
+### Complete Data Quality Workflow
+
+Follow an end-to-end data quality pipeline combining exploration, validation, and profiling:
+
+::: {.gif-container}
+![Complete Workflow](../../assets/vhs/cli-complete-workflow.gif)
+*Full pipeline: explore → validate → profile → automate*
+:::
+
+## Getting Started
+
+Ready to implement data quality workflows? Here's how to get started:
+
+### 1. Install and Verify
+
+```bash
+pip install pointblank
+pb --help
+```
+
+### 2. Explore Your Data
+
+```bash
+# Get a quick preview of your data
+pb preview small_table
+
+# Check for missing values
+pb missing small_table
+
+# Generate column summaries
+pb scan small_table
+```
+
+### 3. Run Essential Validations
+
+```bash
+# Check for duplicate rows
+pb validate-simple small_table --check rows-distinct
+
+# Verify no null values
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extract failing data for debugging
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+### 4. Integrate with CI/CD
+
+```bash
+# Use exit codes for automation (0 = pass, 1 = fail)
+pb validate-simple small_table --check rows-distinct && echo "✅ Quality checks passed"
+```
+
+::: {.callout-tip}
+## Next Steps
+- visit the [CLI User Guide](../../user-guide/cli.qmd) for detailed documentation
+- use `pb validate-simple --help` for validation command options
+- Combine exploration, validation, and profiling for robust data quality pipelines
+:::

{pointblank-0.10.0 → pointblank-0.11.0}/docs/demos/index.qmd

@@ -171,4 +171,7 @@ The schema of a table can be flexibly defined with `Schema` and verified with `c
 [Using Parquet Data](./using-parquet-data/index.qmd)<br>
 A Parquet dataset can be used for data validation, thanks to Ibis.
 
+[CLI Interactive Demos](./cli-interactive/index.qmd)<br>
+These CLI demos showcase practical data quality workflows that you can use!
+
 </div>

{pointblank-0.10.0 → pointblank-0.11.0}/docs/index.qmd

@@ -116,6 +116,51 @@ validation.get_step_report(i=3).show("browser")  # Get failing records from step
 
 </div>
 
+## Command Line Interface (CLI)
+
+Pointblank includes a powerful CLI utility called `pb` that lets you run data validation workflows directly from the command line. Perfect for CI/CD pipelines, scheduled data quality checks, or quick validation tasks.
+
+<div style="text-align: center;">
+
+![](/assets/vhs/cli-complete-workflow.gif){width=100%}
+
+</div>
+
+**Explore Your Data**
+
+```bash
+# Get a quick preview of your data
+pb preview small_table
+
+# Check for missing values
+pb missing small_table
+
+# Generate column summaries
+pb scan small_table
+```
+
+**Run Essential Validations**
+
+```bash
+# Check for duplicate rows
+pb validate-simple small_table --check rows-distinct
+
+# Verify no null values
+pb validate-simple small_table --check col-vals-not-null --column a
+
+# Extract failing data for debugging
+pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+```
+
+**Integrate with CI/CD**
+
+```bash
+# Use exit codes for automation (0 = pass, 1 = fail)
+pb validate-simple small_table --check rows-distinct && echo "✅ Quality checks passed"
+```
+
+Learn more in our [CLI documentation](https://posit-dev.github.io/pointblank/user-guide/cli.html).
+
 ## Join the Community
 
 We'd love to hear from you! Connect with us:
@@ -154,6 +199,25 @@ pip install "pointblank[postgres]" # Install Pointblank with Ibis + PostgreSQL
 pip install "pointblank[sqlite]"   # Install Pointblank with Ibis + SQLite
 ```
 
+## Command Line Interface
+
+Pointblank provides a powerful CLI for quick data validation without writing Python code. Now featuring enhanced validation checks including `col-vals-lt` and `col-vals-le`:
+
+::: {style="text-align: center; margin: 20px 0;"}
+![CLI Quick Demo](assets/vhs/cli-features.gif)
+:::
+
+```bash
+# Quick validation checks from the terminal
+pb validate-simple data.csv --check rows-distinct
+pb validate-simple sales.csv --check col-vals-gt --column revenue --value 0
+pb validate-simple users.csv --check col-vals-lt --column age --value 120  # NEW!
+pb validate-simple inventory.csv --check col-vals-le --column stock --value 1000  # NEW!
+pb validate-simple users.csv --check col-not-null --column email --show-extract
+```
+
+The CLI is perfect for CI/CD pipelines, shell scripts, and exploratory data analysis. See the [CLI documentation](user-guide/cli.qmd) for complete details and [interactive demos](demos/cli-interactive/index.qmd) for live examples.
+
 ## Technical Details
 
 Pointblank uses [Narwhals](https://github.com/narwhals-dev/narwhals) to work with Polars and Pandas DataFrames, and integrates with [Ibis](https://github.com/ibis-project/ibis) for database and file format support. This architecture provides a consistent API for validating tabular data from various sources.