Merge pull request #3 from COVESA/rename_akm_parser

rename to akm_validator
COVESA · Apr 17, 2024 · 778f04c · 778f04c
2 parents 4ac2f57 + a247d33
commit 778f04c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -42,12 +42,12 @@ Poetry is a tool for dependency management and packaging in Python.
 5. You can now run the module with Poetry  (without poetry shell)
 
     ```
-    poetry run akm_tools/akm_parser.py
+    poetry run akm_tools/akm_validator.py
     ```
 6. Or with Poetry shell enabled. (normally your terminal prompt will be prefixed with it)
 
     ```
-    python akm_tools/akm_parser.py
+    python akm_tools/akm_validator.py
     ```
 
 ## Setup and Use with DevContainer
@@ -85,13 +85,13 @@ A DevContainer, or Development Container, is a reproducible development environm
 5. Once the Codespace is ready, you can start working with the code. You can run the module with Poetry:
 
     ```
-    poetry run akm_tools/akm_parser.py
+    poetry run akm_tools/akm_validator.py
     ```
 
 6. Or with Poetry shell enabled. (normally your terminal prompt will be prefixed with it)
 
     ```
-    python akm_tools/akm_parser.py
+    python akm_tools/akm_validator.py
     ```
 
 Refer to [akm_tools/README.MD](akm_tools/README.md) for instructions on how to use the tools.
diff --git a/akm_tools/README.md b/akm_tools/README.md
@@ -10,7 +10,7 @@ This project provides a set of tools for parsing, validating, and exporting Auto
 
 ## Usage
 
-The main functionality is accessed through the command line interface (CLI) provided by `akm_parser.py`. Below are the available options and their descriptions:
+The main functionality is accessed through the command line interface (CLI) provided by `akm_validator.py`. Below are the available options and their descriptions:
 
 ### Command Line Arguments
 
@@ -26,12 +26,12 @@ The main functionality is accessed through the command line interface (CLI) prov
 
 Validate data without exporting:
 ```
-python akm_tools/akm_parser.py -xd your_extended_data_folder
+python akm_tools/akm_validator.py -xd your_extended_data_folder
 ```
 
 Export validated data to JSON:
 ```
-python akm_tools/akm_parser.py -d your_model_data_folder -e json -f path/to/export.json
+python akm_tools/akm_validator.py -d your_model_data_folder -e json -f path/to/export.json
 ```
 ### Logging
 Validation errors are logged to validation_errors.log, aiding in troubleshooting and ensuring data quality.
diff --git a/akm_tools/akm_parser.py → akm_tools/akm_validator.py b/akm_tools/akm_parser.py → akm_tools/akm_validator.py