From 9a56a2ab023ddc7245ef34d391224ff56c6d43d3 Mon Sep 17 00:00:00 2001 From: "george.robertson1" <50412379+georgeRobertson@users.noreply.github.com> Date: Tue, 16 Jun 2026 16:25:35 +0100 Subject: [PATCH] docs: add conda installation information to docs updated some badges on the readme to reflect latest versions released in pypi and conda --- README.md | 3 ++- docs/user_guidance/install.md | 7 +++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1f3ae54..7c16bb5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ ![License](https://img.shields.io/github/license/NHSDigital/data-validation-engine) -![Version](https://img.shields.io/github/v/release/NHSDigital/data-validation-engine) +![PyPi](https://img.shields.io/pypi/v/data-validation-engine) +![Conda](https://anaconda.org/nhs/data-validation-engine/badges/version.svg) [![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) [![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) diff --git a/docs/user_guidance/install.md b/docs/user_guidance/install.md index 2996758..8c93e5c 100644 --- a/docs/user_guidance/install.md +++ b/docs/user_guidance/install.md @@ -71,8 +71,11 @@ You can install the DVE package through python package managers such as [pip](ht poetry install ``` -!!! info - 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. +=== "conda" + + ```sh + conda install nhs::data-validation-engine + ``` 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.