Skip to content

Commit f443288

Browse files
committed
Update README.md
1 parent af6c13f commit f443288

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,14 @@ _Find out if your data is what you think it is._
1919

2020
</div>
2121

22-
Pointblank is a table validation and testing library for Python. It helps you ensure that your tabular data meets certain expectations and constraints and it presents the results in a beautiful (and useful!) validation table.
22+
Pointblank is a table validation and testing library for Python. It helps you ensure that your
23+
tabular data meets certain expectations and constraints and it presents the results in a beautiful,
24+
and useful, validation report table.
2325

2426
## Getting Started
2527

26-
Let's take a Polars DataFrame and validate it against a set of constraints. We do that by using the `pb.Validate` class and then adding validation steps:
28+
Let's take a Polars DataFrame and validate it against a set of constraints. We do that by using the
29+
`Validate` class along with adding validation steps:
2730

2831
```python
2932
import pointblank as pb
@@ -41,9 +44,15 @@ validation
4144

4245
<img src="images/pointblank-tabular-report.png" alt="Validation Report">
4346

44-
The rows in the validation table correspond to each of the validation steps. One of the key concepts is that validation steps can be broken down into atomic test cases (test units) and each of these test units is given either of pass/fail status based on the validation constraints. You'll see these tallied up in the reporting table (in the `UNITS`, `PASS`, and `FAIL` columns).
47+
The rows in the validation table correspond to each of the validation steps. One of the key concepts
48+
is that validation steps can be broken down into atomic test cases (test units) and each of these
49+
test units is given either of pass/fail status based on the validation constraints. You'll see these
50+
tallied up in the reporting table (in the `UNITS`, `PASS`, and `FAIL` columns).
4551

46-
Tabular reporting is just one way to see the results. You can also obtain fine-grained results of the interrogation as JSON output or through methods that get key metrics. You can also utilize the validation results to perform filtering of the input table based on row-level pass/fail status (via the `get_sundered_data()` method).
52+
The tabular reporting view is just one way to see the results. You can also obtain fine-grained
53+
results of the interrogation as JSON output or through methods that get key metrics. You can also
54+
utilize the validation results to perform filtering of the input table based on row-level pass/fail
55+
status (via the `get_sundered_data()` method).
4756

4857
On the input side, we can use the following types of tables:
4958

@@ -55,7 +64,11 @@ On the input side, we can use the following types of tables:
5564
- SQLite table
5665
- Parquet
5766

58-
To make this all work seamlessly, we use [Narwhals](https://github.com/narwhals-dev/narwhals) to work with Polars and Pandas DataFrames. We also integrate with [Ibis](https://github.com/ibis-project/ibis) to enable the use of DuckDB, MySQL, PostgreSQL, SQLite, and Parquet. In doing all of this, we can provide an ergonomic and consistent API for validating tabular data from various sources.
67+
To make this all work seamlessly, we use [Narwhals](https://github.com/narwhals-dev/narwhals) to
68+
work with Polars and Pandas DataFrames. We also integrate with
69+
[Ibis](https://github.com/ibis-project/ibis) to enable the use of DuckDB, MySQL, PostgreSQL, SQLite,
70+
Parquet, and more! In doing all of this, we can provide an ergonomic and consistent API for
71+
validating tabular data from various sources.
5972

6073
## Features
6174

@@ -82,23 +95,32 @@ You can install Pointblank using pip:
8295
pip install pointblank
8396
```
8497

85-
If you encounter a bug, have usage questions, or want to share ideas to make this package better, please feel free to file an [issue](https://github.com/rich-iannone/pointblank/issues).
98+
If you encounter a bug, have usage questions, or want to share ideas to make this package better,
99+
please feel free to file an [issue](https://github.com/rich-iannone/pointblank/issues).
86100

87101
## Code of Conduct
88102

89-
Please note that the pointblank project is released with a [contributor code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).<br>By participating in this project you agree to abide by its terms.
103+
Please note that the pointblank project is released with a
104+
[contributor code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
105+
<br>By participating in this project you agree to abide by its terms.
90106

91107
## Contributing to Pointblank
92108

93-
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!
109+
There are many ways to contribute to the ongoing development of Pointblank. Some contributions can
110+
be simple (like fixing typos, improving documentation, filing issues for feature requests or
111+
problems, etc.) and others might take more time and care (like answering questions and submitting
112+
PRs with code changes). Just know that anything you can do to help would be very much appreciated!
94113

95-
Please read over the [contributing guidelines](https://github.com/rich-iannone/pointblank/blob/main/CONTRIBUTING.md) for information on how to get started.
114+
Please read over the
115+
[contributing guidelines](https://github.com/rich-iannone/pointblank/blob/main/CONTRIBUTING.md) for
116+
information on how to get started.
96117

97118
## 📄 License
98119

99120
Pointblank is licensed under the MIT license.
100121

101122
## 🏛️ Governance
102123

103-
This project is primarily maintained by [Rich Iannone](https://bsky.app/profile/richmeister.bsky.social).
104-
Other authors may occasionally assist with some of these duties.
124+
This project is primarily maintained by
125+
[Rich Iannone](https://bsky.app/profile/richmeister.bsky.social). Other authors may occasionally
126+
assist with some of these duties.

0 commit comments

Comments
 (0)