From eb24ec2d51ae5b931a60800bb6101913212121a0 Mon Sep 17 00:00:00 2001 From: Dan Smith Date: Mon, 25 Sep 2023 16:52:51 +0100 Subject: [PATCH] Pull together multiple README files into a single one --- README.md | 19 +++++++++++++++++++ data-quality-profiler/README.md | 31 ------------------------------- 2 files changed, 19 insertions(+), 31 deletions(-) delete mode 100644 data-quality-profiler/README.md diff --git a/README.md b/README.md index 3a643f9..97e5dce 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,25 @@ Provides the following: * Examples and Usage: [examples](examples) +## Usage + +Releases are being managed by `6point6` at: https://github.com/6point6/data-quality-profiler-and-rules-engine + +Changes are pushed upstream to the `UKHomeOffice` repo at: https://github.com/UKHomeOffice/data-quality-profiler-and-rules-engine + + +To use the Data Profiler classes, add the following dependency to your `build.sbt`, where the library is published to Maven Central: + + libraryDependencies += "io.github.6point6" %% "data-quality-profiler-and-rules-engine" % "1.1.0" + + +## Authors + +Feel free to contex the authors for help/assistance. + +Dr Daniel A. Smith - [dan.smith@6point6.co.uk](dan.smith@6point6.co.uk) - @danielsmith-eu + + # Licence Licensed under the MIT License. See [LICENSE](LICENSE) diff --git a/data-quality-profiler/README.md b/data-quality-profiler/README.md deleted file mode 100644 index d430185..0000000 --- a/data-quality-profiler/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# DAS Data Profiler - -DAS Data Profiler provides the following: - -* Data Profilers for large volume data profiling in Spark -* Assertion rule definitions and checking -* Reference data loading and joining -* Excel and CSV reference data parsing -* JSON output enriched with data quality markers/profilers -* Metrics and summary dataframe output -* Dimensional tagging of profiler outputs (additional identifiers) -* JSON flattener -* JSON and CSV loader, extensible to other formats -* Custom key pre-processor and custom parquet row reader functionality -* Comprehensive built-in assertion rules modules, extensible -* Built-in set of field-level profile masks -* Compound assertion rule definition (i.e. a set of sub-rules must all pass) -* Human-readable Data Quality and Assertion Rule Compliance report output - -## Usage - -Releases are being managed by `6point6` at: https://github.com/6point6/data-quality-profiler-and-rules-engine - -Changes are pushed upstream to the `UKHomeOffice` repo at: https://github.com/UKHomeOffice/data-quality-profiler-and-rules-engine - - -To use the Data Profiler classes, add the following dependency to your `build.sbt`, where the library is published to Maven Central: - - libraryDependencies += "io.github.6point6" %% "data-quality-profiler-and-rules-engine" % "1.1.0" - -Licensed under the MIT License. See [LICENSE](LICENSE)