From 247343cba52e8628e30bcc950c6e379e7d6f747d Mon Sep 17 00:00:00 2001 From: zargot Date: Tue, 3 Dec 2024 10:33:44 -0500 Subject: [PATCH 1/5] correct changelog - correct v0.6 release date - mention tool dir change --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 70a47ecd..8fed2e06 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,11 @@ # Changelog -## [0.6.0] - 2024-12-02 +## [0.6.0] - 2024-12-03 ### General - Added CLI command `odm-validate` +- Changed location of tools to `src/odm_validation/tools` - Fixed documentation generation - Fixed issue where empty values triggered rules "less-than-min-length" and "invalid_category" From 88f07b749f82bced368457f1f60399dfe633c069 Mon Sep 17 00:00:00 2001 From: zargot Date: Tue, 3 Dec 2024 10:36:43 -0500 Subject: [PATCH 2/5] doc/readme: fix indent --- docs/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index f9a5288e..ede4f1ce 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,11 +3,11 @@ 1. Install [Quarto](https://quarto.org/docs/get-started/) 1. Run the following commands to generate this documentation: - ``` - python3 tools/render_quarto_docs.py - cd docs - pip install -r requirements.txt - make html - ``` + ``` + python3 tools/render_quarto_docs.py + cd docs + pip install -r requirements.txt + make html + ``` 1. Open `file:///docs/build/html/index.html` in your browser. From 5931422f5c64479a74bb6db731480c401ec9b6f3 Mon Sep 17 00:00:00 2001 From: zargot Date: Tue, 3 Dec 2024 10:38:39 -0500 Subject: [PATCH 3/5] doc/readme: tweak --- docs/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index ede4f1ce..fc04fa50 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,9 @@ -# Documentation generation +# Documentation + +## Generation 1. Install [Quarto](https://quarto.org/docs/get-started/) -1. Run the following commands to generate this documentation: +1. From the repo root directory, run the following commands: ``` python3 tools/render_quarto_docs.py From 9fd9735aa7bcea42811828d6e9535e1578ae1981 Mon Sep 17 00:00:00 2001 From: zargot Date: Tue, 3 Dec 2024 10:38:59 -0500 Subject: [PATCH 4/5] doc: correct tools path --- docs/README.md | 2 +- docs/specs/summarize-tool.qmd | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index fc04fa50..0713e3fc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ 1. From the repo root directory, run the following commands: ``` - python3 tools/render_quarto_docs.py + python3 src/odm_validation/tools/render_quarto_docs.py cd docs pip install -r requirements.txt make html diff --git a/docs/specs/summarize-tool.qmd b/docs/specs/summarize-tool.qmd index 2a6f2057..f9541849 100644 --- a/docs/specs/summarize-tool.qmd +++ b/docs/specs/summarize-tool.qmd @@ -1,13 +1,14 @@ # Summarize Tool The summarization tool "summarize" is used to create a summarized version of -the validation report. It can be found in the `tools` subdirectory of the -repository. It should use the report file outputted from the validation tool -(`tools/validate`) as its input, and it will output a summarized report file. +the validation report. It can be found in the `src/odm_validation/tools` +directory in the repository. It should use the report file outputted from the +validation tool (`validate.py`) as its input, and it will output a +summarized report file. ## Usage -` python tools/summarize [options...]` +`python summarize.py [options...]` ### Options @@ -77,7 +78,7 @@ The following command will summarize the validation report by tables, columns and rows, and write the result to the console using markdown syntax. ```{shell} -> cd tools +> cd src/odm_validation/tools > ./summarize.py $REPORT --by=table --by=column --by=row --format=markdown # summary @@ -141,7 +142,7 @@ format is implied by the '.yml' file extension. ```{shell} > SUMMARY=$DIR/report-summary.yml -> cd tools +> cd src/odm_validation/tools > ./summarize.py $REPORT --by=table --by=column --by=row --out=$SUMMARY > cat $SUMMARY From 7a09b8a8fc7cb9c42dfe8a647e450248dcc587ae Mon Sep 17 00:00:00 2001 From: zargot Date: Tue, 3 Dec 2024 13:19:24 -0500 Subject: [PATCH 5/5] bump version --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index bd7dfe3d..fbe5fe25 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "odm_validation" -version = "0.6.0" +version = "0.6.1" authors = [ { name="OHRI", email="PHES-ODM@ohri.ca" } ]