Skip to content

Commit b04aab4

Browse files
docs: update contents of readme
1 parent 2c0953c commit b04aab4

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Data Validation Engine
1+
<h1>
2+
<img src="overrides/.icons/nhseng.svg" alt="NHS Logo", width="60" style= "vertical-align: -21px;">
3+
Data Validation Engine
4+
</h1>
5+
6+
![License](https://img.shields.io/github/license/NHSDigital/data-validation-engine)
7+
![Version](https://img.shields.io/github/v/release/NHSDigital/data-validation-engine)
8+
[![CI Unit Tests](https://github.com/NHSDigital/data-validation-engine/actions/workflows/ci_testing.yml/badge.svg)](https://github.com/NHSDigital/data-validation-engine/actions/workflows/ci_testing.yml)
9+
[![CI Formatting & Linting](https://github.com/NHSDigital/data-validation-engine/actions/workflows/ci_linting.yml/badge.svg)](https://github.com/NHSDigital/data-validation-engine/actions/workflows/ci_linting.yml)
210

311
The Data Validation Engine (DVE) is a configuration driven data validation library built and utilised by NHS England. Currently the package has been reverted from v1.0.0 release to a 0.x as we feel the package is not yet mature enough to be considered a 1.0.0 release. So please bear this in mind if reading through the commits and references to a v1+ release when on v0.x.
412

@@ -21,22 +29,24 @@ Additionally, if you'd like to contribute a new backend implementation into the
2129

2230
## Installation and usage
2331

24-
The DVE is a Python package and can be installed using `pip`. As of release v0.1.x we currently only supports Python 3.7, with Spark version 3.2.1 and DuckDB version of 1.1.0. We are currently working on upgrading the DVE to work on Python 3.10-3.11 and this will be made available with version v0.2.x release.
32+
The DVE is a Python package and can be installed using `pip`. As of release v0.6.1 we currently support Python 3.10 & 3.11, with Spark version 3.4 and DuckDB version of 1.1. In the future we will be looking to upgrade the DVE to working on a higher versions of Python, DuckDB and Spark.
2533

26-
In addition to a working Python 3.7+ installation you will need OpenJDK 11 installed if you're planning to use the Spark backend implementation.
34+
If you're planning to use the Spark backend implementation, you will also need OpenJDK 11 installed.
2735

2836
Python dependencies are listed in `pyproject.toml`.
2937

3038
To install the DVE package you can simply install using a package manager such as [pip](https://pypi.org/project/pip/).
3139

3240
```
33-
pip install git+https://github.com/NHSDigital/data-validation-engine.git@v0.1.0
41+
pip install git+https://github.com/NHSDigital/data-validation-engine.git@v0.6.1
3442
```
3543

3644
Once you have installed the DVE you are ready to use it. For guidance on how to create your dischema JSON document (configuration), please read the [documentation](./docs/).
3745

3846
Please note - The long term aim is to make the DVE available via PyPi and Conda but we are not quite there yet. Once available this documentation will be updated to contain the new installation options.
3947

48+
Version 0.0.1 does support a working Python 3.7 installation. However, we will not be supporting any issues with that version of the DVE if you choose to use it. __Use at your own risk__.
49+
4050
## Requesting new features and raising bug reports
4151
**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.**
4252

overrides/.icons/nhseng.svg

Lines changed: 4 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)