doc: fix tools path (#245)

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"

docs/README.md

@@ -1,13 +1,15 @@
-# Documentation generation
+# Documentation
+
+## Generation
 
 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
-	```
+1. From the repo root directory, run the following commands:
+
+    ```
+    python3 src/odm_validation/tools/render_quarto_docs.py
+    cd docs
+    pip install -r requirements.txt
+    make html
+    ```
 
 1. Open `file://<repo_path>/docs/build/html/index.html` in your browser.

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 <report-file> [options...]`
+`python summarize.py <report-file> [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
 

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" }
 ]