Skip to main content

Find out if your data is what you think it is.

Project description

Data validation made beautiful and powerful

Python Versions PyPI PyPI Downloads Conda Version License

CI Build Codecov branch Repo Status Documentation

Contributors Discord Contributor Covenant

What is Pointblank?

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.

Getting Started in 30 Seconds

import pointblank as pb

validation = (
   pb.Validate(data=pb.load_dataset(dataset="small_table"))
   .col_vals_gt(columns="d", value=100)             # Validate values > 100
   .col_vals_le(columns="c", value=5)               # Validate values <= 5
   .col_exists(columns=["date", "date_time"])       # Check columns exist
   .interrogate()                                   # Execute and collect results
)

# Get the validation report from the REPL with:
validation.get_tabular_report().show()

# From a notebook simply use:
validation

Why Choose Pointblank?

  • Works with your existing stack - Seamlessly integrates with Polars, Pandas, DuckDB, MySQL, PostgreSQL, SQLite, Parquet, PySpark, Snowflake, and more!
  • Beautiful, interactive reports - Crystal-clear validation results that highlight issues and help communicate data quality
  • Composable validation pipeline - Chain validation steps into a complete data quality workflow
  • Threshold-based alerts - Set 'warning', 'error', and 'critical' thresholds with custom actions
  • Practical outputs - Use validation results to filter tables, extract problematic data, or trigger downstream processes

Real-World Example

import pointblank as pb
import polars as pl

# Load your data
sales_data = pl.read_csv("sales_data.csv")

# Create a comprehensive validation
validation = (
   pb.Validate(
      data=sales_data,
      tbl_name="sales_data",           # Name of the table for reporting
      label="Real-world example.",     # Label for the validation, appears in reports
      thresholds=(0.01, 0.02, 0.05),   # Set thresholds for warnings, errors, and critical issues
      actions=pb.Actions(              # Define actions for any threshold exceedance
         critical="Major data quality issue found in step {step} ({time})."
      ),
      final_actions=pb.FinalActions(   # Define final actions for the entire validation
         pb.send_slack_notification(
            webhook_url="https://hooks.slack.com/services/your/webhook/url"
         )
      ),
      brief=True,                      # Add automatically-generated briefs for each step
   )
   .col_vals_between(            # Check numeric ranges with precision
      columns=["price", "quantity"],
      left=0, right=1000
   )
   .col_vals_not_null(           # Ensure that columns ending with '_id' don't have null values
      columns=pb.ends_with("_id")
   )
   .col_vals_regex(              # Validate patterns with regex
      columns="email",
      pattern="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
   )
   .col_vals_in_set(             # Check categorical values
      columns="status",
      set=["pending", "shipped", "delivered", "returned"]
   )
   .conjointly(                  # Combine multiple conditions
      lambda df: pb.expr_col("revenue") == pb.expr_col("price") * pb.expr_col("quantity"),
      lambda df: pb.expr_col("tax") >= pb.expr_col("revenue") * 0.05
   )
   .interrogate()
)
Major data quality issue found in step 7 (2025-04-16 15:03:04.685612+00:00).
# Get an HTML report you can share with your team
validation.get_tabular_report().show("browser")
# Get a report of failing records from a specific step
validation.get_step_report(i=3).show("browser")  # Get failing records from step 3

Features That Set Pointblank Apart

  • Complete validation workflow - From data access to validation to reporting in a single pipeline
  • Built for collaboration - Share results with colleagues through beautiful interactive reports
  • Practical outputs - Get exactly what you need: counts, extracts, summaries, or full reports
  • Flexible deployment - Use in notebooks, scripts, or data pipelines
  • Customizable - Tailor validation steps and reporting to your specific needs
  • Internationalization - Reports can be generated in over 20 languages, including English, Spanish, French, and German

Documentation and Examples

Visit our documentation site for:

Join the Community

We'd love to hear from you! Connect with us:

Installation

You can install Pointblank using pip:

pip install pointblank

You can also install Pointblank from Conda-Forge by using:

conda install conda-forge::pointblank

If you don't have Polars or Pandas installed, you'll need to install one of them to use Pointblank.

pip install "pointblank[pl]" # Install Pointblank with Polars
pip install "pointblank[pd]" # Install Pointblank with Pandas

To use Pointblank with DuckDB, MySQL, PostgreSQL, or SQLite, install Ibis with the appropriate backend:

pip install "pointblank[duckdb]"   # Install Pointblank with Ibis + DuckDB
pip install "pointblank[mysql]"    # Install Pointblank with Ibis + MySQL
pip install "pointblank[postgres]" # Install Pointblank with Ibis + PostgreSQL
pip install "pointblank[sqlite]"   # Install Pointblank with Ibis + SQLite

Technical Details

Pointblank uses Narwhals to work with Polars and Pandas DataFrames, and integrates with Ibis for database and file format support. This architecture provides a consistent API for validating tabular data from various sources.

Contributing to Pointblank

There are many ways to contribute to the ongoing development of Pointblank. Some contributions can be simple (like fixing typos, improving documentation, filing issues for feature requests or problems, etc.) and others might take more time and care (like answering questions and submitting PRs with code changes). Just know that anything you can do to help would be very much appreciated!

Please read over the contributing guidelines for information on how to get started.

Roadmap

We're actively working on enhancing Pointblank with:

  1. Additional validation methods for comprehensive data quality checks
  2. Advanced logging capabilities
  3. Messaging actions (Slack, email) for threshold exceedances
  4. LLM-powered validation suggestions and data dictionary generation
  5. JSON/YAML configuration for pipeline portability
  6. CLI utility for validation from the command line
  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.

Code of Conduct

Please note that the Pointblank project is released with a contributor code of conduct.
By participating in this project you agree to abide by its terms.

📄 License

Pointblank is licensed under the MIT license.

© Posit Software, PBC.

🏛️ Governance

This project is primarily maintained by Rich Iannone. Other authors may occasionally assist with some of these duties.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pointblank-0.9.0.tar.gz (30.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pointblank-0.9.0-py3-none-any.whl (13.5 MB view details)

Uploaded Python 3

File details

Details for the file pointblank-0.9.0.tar.gz.

File metadata

  • Download URL: pointblank-0.9.0.tar.gz
  • Upload date:
  • Size: 30.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pointblank-0.9.0.tar.gz
Algorithm Hash digest
SHA256 e3d9cdde123a4e9d8f8df094572cd2fbf5b281667d83716ed6d28ae86ecbab9a
MD5 c808f8663df4931184b32a55020bfbad
BLAKE2b-256 09f6e616c0cf320e638d3c0e20991727fc5a489b95908a8c260814d4186ffe04

See more details on using hashes here.

File details

Details for the file pointblank-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: pointblank-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 13.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pointblank-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf728bbb5512094ef91b2113a6bd6c98e95c1a3d4f220366d09fbb8f150ef5ad
MD5 a89ca6a0f53b1ed5f26c4f183078dc87
BLAKE2b-256 4f1af46e70a0ede6621ae0e66eec0856acb19c81f1807db24ff99f58fcb15e2b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page