pointblank

Data validation made beautiful and powerful

https://github.com/posit-dev/pointblank

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary

Keywords

data-quality data-testing data-validation easy-to-understand tabular-data
Last synced: 6 months ago · JSON representation

Repository

Data validation made beautiful and powerful

Basic Info
Statistics
  • Stars: 272
  • Watchers: 4
  • Forks: 19
  • Open Issues: 33
  • Releases: 41
Topics
data-quality data-testing data-validation easy-to-understand tabular-data
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Security

README.md

_Data validation made beautiful and powerful_ [![Python Versions](https://img.shields.io/pypi/pyversions/pointblank.svg)](https://pypi.python.org/pypi/pointblank) [![PyPI](https://img.shields.io/pypi/v/pointblank)](https://pypi.org/project/pointblank/#history) [![PyPI Downloads](https://static.pepy.tech/badge/pointblank)](https://pepy.tech/projects/pointblank) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/pointblank.svg)](https://anaconda.org/conda-forge/pointblank) [![License](https://img.shields.io/github/license/posit-dev/pointblank)](https://img.shields.io/github/license/posit-dev/pointblank) [![CI Build](https://github.com/posit-dev/pointblank/actions/workflows/ci-tests.yaml/badge.svg)](https://github.com/posit-dev/pointblank/actions/workflows/ci-tests.yaml) [![Codecov branch](https://img.shields.io/codecov/c/github/posit-dev/pointblank/main.svg)](https://codecov.io/gh/posit-dev/pointblank) [![Repo Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Documentation](https://img.shields.io/badge/docs-project_website-blue.svg)](https://posit-dev.github.io/pointblank/) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/posit-dev/pointblank) [![Contributors](https://img.shields.io/github/contributors/posit-dev/pointblank)](https://github.com/posit-dev/pointblank/graphs/contributors) [![Discord](https://img.shields.io/discord/1345877328982446110?color=%237289da&label=Discord)](https://discord.com/invite/YH7CybCNCQ) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html)
Franais | Deutsch | Italiano | Espaol | Portugus | Nederlands | | | | |

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

```python import pointblank as pb

validation = ( pb.Validate(data=pb.loaddataset(dataset="smalltable")) .colvalsgt(columns="d", value=100) # Validate values > 100 .colvalsle(columns="c", value=5) # Validate values <= 5 .colexists(columns=["date", "datetime"]) # Check columns exist .interrogate() # Execute and collect results )

Get the validation report from the REPL with:

validation.gettabularreport().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

```python import pointblank as pb import polars as pl

Load your data

salesdata = pl.readcsv("sales_data.csv")

Create a comprehensive validation

validation = ( pb.Validate( data=salesdata, tblname="salesdata", # 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})." ), finalactions=pb.FinalActions( # Define final actions for the entire validation pb.sendslacknotification( webhookurl="https://hooks.slack.com/services/your/webhook/url" ) ), brief=True, # Add automatically-generated briefs for each step ) .colvalsbetween( # Check numeric ranges with precision columns=["price", "quantity"], left=0, right=1000 ) .colvalsnotnull( # Ensure that columns ending with 'id' don't have null values columns=pb.endswith("id") ) .colvalsregex( # Validate patterns with regex columns="email", pattern="^[a-zA-Z0-9.%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$" ) .colvalsinset( # Check categorical values columns="status", set=["pending", "shipped", "delivered", "returned"] ) .conjointly( # Combine multiple conditions lambda df: pb.exprcol("revenue") == pb.exprcol("price") * pb.exprcol("quantity"), lambda df: pb.exprcol("tax") >= pb.exprcol("revenue") * 0.05 ) .interrogate() ) ```

Major data quality issue found in step 7 (2025-04-16 15:03:04.685612+00:00).

```python

Get an HTML report you can share with your team

validation.gettabularreport().show("browser") ```

```python

Get a report of failing records from a specific step

validation.getstepreport(i=3).show("browser") # Get failing records from step 3 ```


YAML Configuration

For teams that need portable, version-controlled validation workflows, Pointblank supports YAML configuration files. This makes it easy to share validation logic across different environments and team members, ensuring everyone is on the same page.

validation.yaml

```yaml validate: data: smalltable tblname: "small_table" label: "Getting started validation"

steps: - colvalsgt: columns: "d" value: 100 - colvalsle: columns: "c" value: 5 - colexists: columns: ["date", "datetime"] ```

Execute the YAML validation

```python import pointblank as pb

Run validation from YAML configuration

validation = pb.yaml_interrogate("validation.yaml")

Get the results just like any other validation

validation.gettabularreport().show() ```

This approach is perfect for:

  • CI/CD pipelines: Store validation rules alongside your code
  • Team collaboration: Share validation logic in a readable format
  • Environment consistency: Use the same validation across dev, staging, and production
  • Documentation: YAML files serve as living documentation of your data quality requirements

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.

Explore Your Data

```bash

Get a quick preview of your data

pb preview small_table

Preview data from GitHub URLs

pb preview "https://github.com/user/repo/blob/main/data.csv"

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

Run validation from YAML configuration file

pb run validation.yaml

Run validation from Python file

pb run validation.py

Check for duplicate rows

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 in Parquet datasets

pb validate "data/*.parquet" --check col-vals-not-null --column a

Extract failing data for debugging

pb validate small_table --check col-vals-gt --column a --value 5 --show-extract ```

Integrate with CI/CD

```bash

Use exit codes for automation in one-liner validations (0 = pass, 1 = fail)

pb validate small_table --check rows-distinct --exit-code

Run validation workflows with exit codes

pb run validation.yaml --exit-code pb run validation.py --exit-code ```

Click the following headings to see some video demonstrations of the CLI:

Getting Started with the Pointblank CLI
Doing Some Data Exploration
Validating Data with the CLI
Using Polars in the CLI
Integrating Pointblank with CI/CD

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:

bash pip install pointblank

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

bash 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.

bash 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:

bash 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.

Pointblank for R

There's also a version of Pointblank for R, which has been around since 2017 and is widely used in the R community. You can find it at https://github.com/rstudio/pointblank.

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.

Owner

  • Name: posit-dev
  • Login: posit-dev
  • Kind: organization

GitHub Events

Total
  • Create event: 134
  • Release event: 28
  • Issues event: 88
  • Watch event: 205
  • Delete event: 101
  • Issue comment event: 246
  • Push event: 1,458
  • Pull request review comment event: 15
  • Pull request review event: 36
  • Pull request event: 235
  • Fork event: 17
Last Year
  • Create event: 134
  • Release event: 28
  • Issues event: 88
  • Watch event: 205
  • Delete event: 101
  • Issue comment event: 246
  • Push event: 1,458
  • Pull request review comment event: 15
  • Pull request review event: 36
  • Pull request event: 235
  • Fork event: 17

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,818
  • Total Committers: 10
  • Avg Commits per committer: 181.8
  • Development Distribution Score (DDS): 0.019
Past Year
  • Commits: 1,818
  • Committers: 10
  • Avg Commits per committer: 181.8
  • Development Distribution Score (DDS): 0.019
Top Committers
Name Email Commits
Richard Iannone r****e@m****m 1,784
Tyler Riccio t****8@g****m 23
Michael Chow m****b@f****m 3
jrycw j****y@y****e 2
Paul Hobson p****n@h****m 1
Malcolm Barrett m****t@g****m 1
Katie Masiello k****o@r****m 1
Gregory Power 3****r 1
Andrea Borruso a****o@g****m 1
Alberson Miranda a****a@h****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 63
  • Total pull requests: 257
  • Average time to close issues: 9 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 19
  • Total pull request authors: 12
  • Average comments per issue: 0.62
  • Average comments per pull request: 1.14
  • Merged pull requests: 218
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 63
  • Pull requests: 257
  • Average time to close issues: 9 days
  • Average time to close pull requests: 1 day
  • Issue authors: 19
  • Pull request authors: 12
  • Average comments per issue: 0.62
  • Average comments per pull request: 1.14
  • Merged pull requests: 218
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rich-iannone (15)
  • tylerriccio33 (15)
  • ptomecek (5)
  • jesusestevez (3)
  • phobson (3)
  • SamEdwardes (3)
  • etiennebacher (3)
  • zilto (2)
  • atseewal (2)
  • paddymul (2)
  • mark-druffel (2)
  • JamesRuss (1)
  • fb-elong (1)
  • emrynHofmannElephant (1)
  • jrycw (1)
Pull Request Authors
  • rich-iannone (206)
  • tylerriccio33 (23)
  • machow (5)
  • phobson (4)
  • jrycw (4)
  • zilto (3)
  • albersonmiranda (2)
  • gregorywaynepower (2)
  • aborruso (2)
  • matt-humphrey (2)
  • kmasiello (2)
  • CarolineHalllin (1)
  • pipaber (1)
Top Labels
Issue Labels
Type: ★ Enhancement (30) Type: ☹︎ Bug (12) Priority: [3] High (9) Difficulty: [2] Intermediate (8) Effort: [2] Medium (6) Type: ⁇ Question (4) Effort: [3] High (4) Difficulty: [3] Advanced (2) Difficulty: [1] Novice (1) Effort: [1] Low (1) Priority: [2] Medium (1) Good First Issue ♥️ (1) Priority: ♨︎ Critical (1) Type: ✎ Docs (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 15,759 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 41
  • Total maintainers: 1
pypi.org: pointblank

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

  • Documentation: https://pointblank.readthedocs.io/
  • License: MIT License Copyright (c) 2024-2025 Posit Software, PBC Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.13.1
    published 6 months ago
  • Versions: 41
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 15,759 Last month
Rankings
Dependent packages count: 9.9%
Average: 32.9%
Dependent repos count: 55.9%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/ci-docs.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v3 composite
  • peaceiris/actions-gh-pages v3 composite
  • quarto-dev/quarto-actions/setup v2 composite
.github/workflows/ci-tests.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v5 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
  • commonmark >=0.9.1
  • great_tables >=0.13.0
  • ibis-framework [duckdb,mysql,postgres,sqlite]>=9.5.0
  • importlib-metadata *
  • narwhals >=1.10.0
  • typing_extensions >=3.10.0.0