Skip to content

Commit ff644e5

Browse files
docs: add conda installation information to docs (#113)
updated some badges on the readme to reflect latest versions released in pypi and conda
1 parent d2b9c81 commit ff644e5

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
</h1>
55

66
![License](https://img.shields.io/github/license/NHSDigital/data-validation-engine)
7-
![Version](https://img.shields.io/github/v/release/NHSDigital/data-validation-engine)
7+
![PyPi](https://img.shields.io/pypi/v/data-validation-engine)
8+
![Conda](https://anaconda.org/nhs/data-validation-engine/badges/version.svg)
89
[![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)
910
[![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)
1011

docs/user_guidance/install.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,11 @@ You can install the DVE package through python package managers such as [pip](ht
7171
poetry install
7272
```
7373

74-
!!! info
75-
We are working on getting the DVE available via Conda. We will update this page with the relevant instructions once this has been successfully setup.
74+
=== "conda"
75+
76+
```sh
77+
conda install nhs::data-validation-engine
78+
```
7679

7780
Python dependencies are listed in the [`pyproject.toml`](https://github.com/NHSDigital/data-validation-engine/blob/main/pyproject.toml). Many of the dependencies are locked to quite restrictive versions due to complexity of this package. Core packages such as Pydantic, Pyspark and DuckDB are unlikely to receive flexible version constraints as changes in those packages could cause the DVE to malfunction. For less important dependencies, we have tried to make the contraints more flexible. Therefore, we would advise you to install the DVE into a seperate environment rather than trying to integrate it into an existing Python environment.
7881

0 commit comments

Comments
 (0)