pointblank 0.11.0__tar.gz → 0.11.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pointblank
-Version: 0.11.0
+Version: 0.11.1
 Summary: Find out if your data is what you think it is.
 Author-email: Richard Iannone <riannone@me.com>
 License: MIT License
@@ -249,31 +249,37 @@ Pointblank includes a powerful CLI utility called `pb` that lets you run data va
 # Get a quick preview of your data
 pb preview small_table
 
-# Check for missing values
-pb missing small_table
+# Preview data from GitHub URLs
+pb preview "https://github.com/user/repo/blob/main/data.csv"
 
-# Generate column summaries
-pb scan small_table
+# Check for missing values in Parquet files
+pb missing data.parquet
+
+# Generate column summaries from database connections
+pb scan "duckdb:///data/sales.ddb::customers"
 ```
 
 **Run Essential Validations**
 
 ```bash
 # Check for duplicate rows
-pb validate-simple small_table --check rows-distinct
+pb validate small_table --check rows-distinct
+
+# Validate data directly from GitHub
+pb validate "https://github.com/user/repo/blob/main/sales.csv" --check col-vals-not-null --column customer_id
 
-# Verify no null values
-pb validate-simple small_table --check col-vals-not-null --column a
+# Verify no null values in Parquet datasets
+pb validate "data/*.parquet" --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
+pb validate 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"
+pb validate 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).

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

@@ -163,31 +163,37 @@ Pointblank includes a powerful CLI utility called `pb` that lets you run data va
 # Get a quick preview of your data
 pb preview small_table
 
-# Check for missing values
-pb missing small_table
+# Preview data from GitHub URLs
+pb preview "https://github.com/user/repo/blob/main/data.csv"
 
-# Generate column summaries
-pb scan small_table
+# Check for missing values in Parquet files
+pb missing data.parquet
+
+# Generate column summaries from database connections
+pb scan "duckdb:///data/sales.ddb::customers"
 ```
 
 **Run Essential Validations**
 
 ```bash
 # Check for duplicate rows
-pb validate-simple small_table --check rows-distinct
+pb validate small_table --check rows-distinct
+
+# Validate data directly from GitHub
+pb validate "https://github.com/user/repo/blob/main/sales.csv" --check col-vals-not-null --column customer_id
 
-# Verify no null values
-pb validate-simple small_table --check col-vals-not-null --column a
+# Verify no null values in Parquet datasets
+pb validate "data/*.parquet" --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
+pb validate 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"
+pb validate 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).

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

@@ -63,7 +63,6 @@ website:
           contents:
             - user-guide/index.qmd
             - user-guide/installation.qmd
-            - user-guide/cli.qmd
         - section: "Validation Plan"
           contents:
             - user-guide/validation-overview.qmd
@@ -90,6 +89,11 @@ website:
             - user-guide/preview.qmd
             - user-guide/col-summary-tbl.qmd
             - user-guide/missing-vals-tbl.qmd
+        - section: "The Pointblank CLI"
+          contents:
+            - user-guide/cli-data-inspection.qmd
+            - user-guide/cli-data-validation.qmd
+
   page-footer:
     left: 'Proudly supported by <a href="https://www.posit.co/" class="no-icon"><img src="/assets/posit-logo-black.svg" alt="Posit" width="80" style="padding-left: 3px;vertical-align:text-top;"></a>'
     right: "&copy; 2024&ndash;2025 Posit Software, PBC."

pointblank-0.11.1/docs/assets/vhs/.gitignore

@@ -0,0 +1 @@
+worldcities.csv

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

@@ -0,0 +1,45 @@
+# 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 "# Example of a Production CI/CD Data Validation Workflow"
+Enter
+Sleep 2s
+
+Type ""
+Enter
+Type "# Pipeline Step 1: Checking for duplicates while using exit codes (this fails)"
+Enter
+Type "pb validate small_table --check rows-distinct --exit-code"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# Pipeline Step 2: Checking for null values in an important column (this passes)"
+Enter
+Type "pb validate small_table --check col-vals-not-null --column date_time --exit-code"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# Pipeline Step 3: Checking for values greater than 2 (this one fails)"
+Enter
+Type "pb validate small_table --check col-vals-gt --column a --value 2 --exit-code"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# Use in GitHub Actions or any automation platform"
+Enter
+Type "echo 'Exit codes: 0 = success, 1 = validation failed'"
+Enter
+Sleep 8s

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

@@ -0,0 +1,75 @@
+# VHS tape for complete validation workflow
+# Shows realistic end-to-end data quality checking with world cities data
+
+Output cli-complete-workflow.gif
+
+Set FontSize 14
+Set Width 1200
+Set Height 900
+Set Theme "Dracula"
+
+Type "# Complete Data Quality Workflow"
+Enter
+Sleep 2s
+
+Type ""
+Enter
+Type "# Step 0: Get the dimensions of your data first"
+Enter
+Type "pb info worldcities.csv"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# Step 1: Quickly preview the dataset"
+Enter
+Type "pb preview worldcities.csv --head 3 --tail 2"
+Enter
+Sleep 6s
+
+Type ""
+Enter
+Type "# Step 2: Scan for data quality patterns"
+Enter
+Type "pb scan worldcities.csv"
+Enter
+Sleep 12s
+
+Type ""
+Enter
+Type "# Step 3: Check for missing values"
+Enter
+Type "pb missing worldcities.csv"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# Step 4: Validate the population values are provided for each city (i.e., not null)"
+Enter
+Type "pb validate worldcities.csv --check col-vals-not-null --column population"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# Step 5: Check for missing city names (and show problematic rows)"
+Enter
+Type "pb validate worldcities.csv --check col-vals-not-null --column city_name --show-extract"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# Step 6: Validate latitude range (latitude: -90 to 90) in two steps"
+Enter
+Type "pb validate worldcities.csv --check col-vals-ge --column latitude --value -90 --check col-vals-le --column latitude --value 90"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "echo 'Data quality workflow complete: 41K cities validated!'"
+Enter
+Sleep 6s

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

@@ -0,0 +1,51 @@
+# VHS tape for data exploration and profiling
+# Shows preview, missing values, and column summaries using real-world city data
+
+Output cli-data-exploration.gif
+
+Set FontSize 14
+Set Width 1200
+Set Height 800
+Set Theme "Dracula"
+
+Type "# Data Exploration & Profiling with the Pointblank CLI"
+Enter
+Sleep 2s
+
+Type ""
+Enter
+Type "# 0. Exploring world cities dataset: get the table dimensions"
+Enter
+Type "pb info worldcities.csv"
+Enter
+Sleep 4s
+
+Type ""
+Enter
+Type "# 1. Quick data preview: see structure and sample rows"
+Enter
+Type "pb preview worldcities.csv --head 3 --tail 3"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# 2. Missing values analysis: identify data gaps"
+Enter
+Type "pb missing worldcities.csv"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# 3. Comprehensive data scan: statistical overview"
+Enter
+Type "pb scan worldcities.csv"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "echo 'Complete data profiling in seconds with the Pointblank CLI'"
+Enter
+Sleep 3s

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

@@ -0,0 +1,51 @@
+# 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 4s
+
+Type ""
+Enter
+Type "# 0. Get the table dimensions, just to know what you're working with"
+Enter
+Type "pb info small_table"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# 1. Check for duplicate rows (the most common data quality issue)"
+Enter
+Type "pb validate small_table --check rows-distinct"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# 2. Find missing values in important columns"
+Enter
+Type "pb validate small_table --check col-vals-not-null --column c"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# 3. When validation fails, see exactly which rows are problematic with --show-extract"
+Enter
+Type "pb validate small_table --check col-vals-not-null --column c --show-extract"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "echo 'Essential validations: duplicates, nulls, with data extracts'"
+Enter
+Sleep 6s

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

@@ -0,0 +1,51 @@
+# 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 the Pointblank CLI"
+Enter
+Sleep 5s
+
+Type ""
+Enter
+Type "# See all available commands"
+Enter
+Type "pb --help"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# There's a number of datasets you can use for testing"
+Enter
+Type "pb datasets"
+Enter
+Sleep 8s
+
+Type ""
+Enter
+Type "# Learn about all the `pb validate` options"
+Enter
+Type "pb validate --help"
+Enter
+Sleep 12s
+
+Type ""
+Enter
+Type "# Your first validation: check for duplicates with rows-distinct"
+Enter
+Type "pb validate small_table --check rows-distinct"
+Enter
+Sleep 10s
+
+Type ""
+Enter
+Type "# You are now ready to validate any dataset you like: CSV, Parquet, or a DB table"
+Enter
+Sleep 5s

{pointblank-0.11.0 → pointblank-0.11.1}/docs/demos/cli-interactive/index.qmd

@@ -23,8 +23,6 @@ format:
       }
 ---
 
-# Command Line Interface: Interactive Demos
-
 These CLI demos showcase practical data quality workflows that you can use!
 
 ::: {.callout-tip}
@@ -62,9 +60,9 @@ See the most commonly used validation checks that catch critical data issues:
 *Duplicate detection, null checks, and data extract debugging*
 :::
 
-### Data Exploration Without Python
+### Data Exploration Tools
 
-Discover how to profile and explore data using CLI tools that don't require Python knowledge:
+Discover how to profile and explore data using CLI tools that are quick and easy to use:
 
 ::: {.gif-container}
 ![Data Exploration](../../assets/vhs/cli-data-exploration.gif)
@@ -86,56 +84,55 @@ Follow an end-to-end data quality pipeline combining exploration, validation, an
 
 ::: {.gif-container}
 ![Complete Workflow](../../assets/vhs/cli-complete-workflow.gif)
-*Full pipeline: explore → validate → profile → automate*
+*Full pipeline: explore → validate → automate*
 :::
 
 ## Getting Started
 
 Ready to implement data quality workflows? Here's how to get started:
 
-### 1. Install and Verify
+#### 1. Install and Verify
 
 ```bash
 pip install pointblank
 pb --help
 ```
 
-### 2. Explore Your Data
+#### 2. Explore Various Data Sources
 
 ```bash
-# Get a quick preview of your data
+# Try previewing a built-in dataset
 pb preview small_table
 
-# Check for missing values
-pb missing small_table
+# Access local files (even use patterns to combine multiple Parquet files)
+pb preview sales_data.csv
+pb scan "data/*.parquet"
+
+# Inspect datasets in GitHub repositories (no need to download the data!)
+pb preview "https://github.com/user/repo/blob/main/data.csv"
+pb missing "https://raw.githubusercontent.com/user/repo/main/sales.parquet"
 
-# Generate column summaries
-pb scan small_table
+# Work with DB tables through connection strings
+pb info "duckdb:///warehouse/analytics.ddb::customers"
 ```
 
-### 3. Run Essential Validations
+#### 3. Run Essential Validations
 
 ```bash
 # Check for duplicate rows
-pb validate-simple small_table --check rows-distinct
+pb validate small_table --check rows-distinct
 
-# Verify no null values
-pb validate-simple small_table --check col-vals-not-null --column a
+# Validate data from multiple sources
+pb validate "data/*.parquet" --check col-vals-not-null --column customer_id
+pb validate "https://github.com/user/repo/blob/main/sales.csv" --check rows-distinct
 
 # Extract failing data for debugging
-pb validate-simple small_table --check col-vals-gt --column a --value 5 --show-extract
+pb validate small_table --check col-vals-gt --column a --value 5 --show-extract
 ```
 
-### 4. Integrate with CI/CD
+#### 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"
+pb validate small_table --check rows-distinct --exit-code
 ```
-
-::: {.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.11.0 → pointblank-0.11.1}/docs/index.qmd

@@ -11,9 +11,13 @@ _Data validation made beautiful and powerful_
 
 </div>
 
-Pointblank is a powerful, yet elegant data validation framework for Python that transforms how you ensure data quality. With its intuitive, chainable API, you can quickly validate your data against comprehensive quality checks and visualize results through stunning, interactive reports that make data issues immediately actionable.
+Pointblank is a powerful, yet elegant data validation framework for Python that transforms how you
+ensure data quality. With its intuitive, chainable API, you can quickly validate your data against
+comprehensive quality checks and visualize results through stunning, interactive reports that make
+data issues immediately actionable.
 
-Whether you're a data scientist, data engineer, or analyst, Pointblank helps you catch data quality issues before they impact your analyses or downstream systems.
+Whether you're a data scientist, data engineer, or analyst, Pointblank helps you catch data quality
+issues before they impact your analyses or downstream systems.
 
 ## Getting Started in 30 Seconds
 
@@ -116,9 +120,11 @@ validation.get_step_report(i=3).show("browser")  # Get failing records from step
 
 </div>
 
-## Command Line Interface (CLI)
+## Command Line Interface
 
-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.
+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;">
 
@@ -143,20 +149,20 @@ pb scan small_table
 
 ```bash
 # Check for duplicate rows
-pb validate-simple small_table --check rows-distinct
+pb validate small_table --check rows-distinct
 
 # Verify no null values
-pb validate-simple small_table --check col-vals-not-null --column a
+pb validate 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
+pb validate 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"
+pb validate 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).
@@ -199,28 +205,12 @@ 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.
+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.
 
 ## Contributing to Pointblank
 
@@ -245,7 +235,8 @@ We're actively working on enhancing Pointblank with:
 7. Expanded backend support and certification
 8. High-quality documentation and examples
 
-If you have any ideas for features or improvements, don't hesitate to share them with us! We are always looking for ways to make Pointblank better.
+If you have any ideas for features or improvements, don't hesitate to share them with us! We are
+always looking for ways to make Pointblank better.
 
 ## Code of Conduct