Data Validation Engine
The Data Validation Engine (DVE) is a configuration-driven data validation library created and used by NHS England. It lets users define validation rules once and apply them across multiple dataset collections - supporting consistent, accurate data checks.
The DVE offers:
- SQL configuration-based validations
- Format normalization to Parquet for a unified data representation
- Data modelling and typecasting
- Business-rule validations executed on supported backends such as Spark and DuckDB, with the option to add custom backends
- Deriving new fields and entities
- Clear validation reporting, including summary insights and record-level error messages
As mentioned above, the DVE is "configuration driven" which means the majority of development for you as a user will be building a JSON document to describe how the data will be validated. The JSON document is known as a dischema (data ingest schema) file and example files can be accessed here ↗️. If you'd like to learn more about JSON document and how to build one from scratch, then please read the documentation here ↗️.
Installation and usage
Please see the documentation here ↗️.
Requesting new features and raising bug reports
Before creating new issues, please check to see if the same bug/feature has been created already. Where a duplicate is created, the ticket will be closed and referenced to an existing issue.
If you have spotted a bug with the DVE then please raise an issue here ↗️ using the "bug template".
If you have feature request then please follow the same process whilst using the "Feature request template".
Upcoming features
Below is a list of features that we would like to implement or have been requested.
| Feature | Release Version | Released? |
|---|---|---|
| Open source release | 0.1.0 | Yes |
| Uplift to Python 3.11 | 0.2.0 | Yes |
| Uplift Pyspark to 3.5 | 0.8.0 | Yes |
| Allow DVE to run on Python 3.12+ | 0.8.0 | Yes |
| Upgrade to Pydantic 2.0 | 0.9.0 | Yes |
| Uplift Pyspark to 4.0+ | TBA | No |
| Polars upgrade to v1+ | TBA | No |
| DuckDB upgrade to v1.5+ | TBA | No |
| Python 3.13 & 3.14 upgrade | TBA | No |
| Create a more user friendly interface for building and modifying dischema files | TBA | No |
If you are interested in getting any of the unreleased features listed above available, then please read the Contributing section and then submit us a pull request.
Contributing
Please see guidance here ↗️.
Legal
This codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
Any HTML or Markdown documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file data_validation_engine-0.9.0.tar.gz.
File metadata
- Download URL: data_validation_engine-0.9.0.tar.gz
- Upload date:
- Size: 157.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e0052bb85888088ebb823fa9918d9e28aa5fccd06c0caaedb8c305c58d7816ae
|
|
| MD5 |
75c38766de99299701456b2b8f3c070f
|
|
| BLAKE2b-256 |
580aa37873067b2511a259feb4f759ef625797776ebc32630d69dfbcfbbe6a4c
|
Provenance
The following attestation bundles were made for data_validation_engine-0.9.0.tar.gz:
Publisher:
ci_pypi_publish.yml on NHSDigital/data-validation-engine
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
data_validation_engine-0.9.0.tar.gz -
Subject digest:
e0052bb85888088ebb823fa9918d9e28aa5fccd06c0caaedb8c305c58d7816ae - Sigstore transparency entry: 2436728807
- Sigstore integration time:
-
Permalink:
NHSDigital/data-validation-engine@24c2f48f42c620eec263e40b2202d30f0bc662ff -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/NHSDigital
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_pypi_publish.yml@24c2f48f42c620eec263e40b2202d30f0bc662ff -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file data_validation_engine-0.9.0-py3-none-any.whl.
File metadata
- Download URL: data_validation_engine-0.9.0-py3-none-any.whl
- Upload date:
- Size: 207.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c289bb6191334c144e0dd4af041e7a440414b4ad6313c4d53db1f720b344467
|
|
| MD5 |
aa32de998d33b845c2fe14416822f393
|
|
| BLAKE2b-256 |
aa2ef7582e72ee4a7a401ff73db147c9b1d7b415dc3d2684d79ebc8d887855d1
|
Provenance
The following attestation bundles were made for data_validation_engine-0.9.0-py3-none-any.whl:
Publisher:
ci_pypi_publish.yml on NHSDigital/data-validation-engine
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
data_validation_engine-0.9.0-py3-none-any.whl -
Subject digest:
4c289bb6191334c144e0dd4af041e7a440414b4ad6313c4d53db1f720b344467 - Sigstore transparency entry: 2436728826
- Sigstore integration time:
-
Permalink:
NHSDigital/data-validation-engine@24c2f48f42c620eec263e40b2202d30f0bc662ff -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/NHSDigital
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_pypi_publish.yml@24c2f48f42c620eec263e40b2202d30f0bc662ff -
Trigger Event:
workflow_dispatch
-
Statement type:
