Updated README

OP-TED · Apr 26, 2022 · c3dd05f · c3dd05f
1 parent c02b145
commit c3dd05f
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,9 @@ make setup
 ## Usage
 ### CLI tools (commands/console-scripts) for notice mapping suite manipulation
 
-#### normalisation_resource_generator
+Using MAPPING_SUITE_ID argument should be enough for general purpose.
+
+#### CMD: normalisation_resource_generator
 Generates all resources files needed for notice mapping suite transformation.
 
 Use:
@@ -51,13 +53,13 @@ to get the Usage Help:
 Usage: normalisation_resource_generator [OPTIONS] [MAPPING_SUITE_ID]
 
 Options:
-  --opt-queries-folder TEXT
-  --opt-output-folder TEXT
+  -i, --opt-queries-folder TEXT               Use to overwrite default INPUT generator
+  -o, --opt-output-folder TEXT                Use to overwrite default OUTPUT generator
   -m, --opt-mappings-path TEXT
   --help                                      Show this message and exit.
 ```
 
-#### metadata_generator
+#### CMD: metadata_generator
 Generates metadata.json file from Conceptual Mappings file data.
 
 Use:
@@ -71,13 +73,13 @@ Usage: metadata_generator [OPTIONS] [MAPPING_SUITE_ID]
   Generates Metadata from Conceptual Mappings.
 
 Options:
-  -i, --opt-conceptual-mappings-file TEXT     Use to overwrite INPUT generator
-  -o, --opt-output-metadata-file TEXT         Use to overwrite OUTPUT generator
+  -i, --opt-conceptual-mappings-file TEXT     Use to overwrite default INPUT generator
+  -o, --opt-output-metadata-file TEXT         Use to overwrite default OUTPUT generator
   -m, --opt-mappings-path TEXT
   --help                                      Show this message and exit.
 ```
 
-#### yarrrml2rml_converter
+#### CMD: yarrrml2rml_converter
 Converts YARRRML data to RML data.
 
 Use:
@@ -91,13 +93,13 @@ Usage: yarrrml2rml_converter [OPTIONS] [MAPPING_SUITE_ID] [RML_OUTPUT_FILE_NAME]
   Converts YARRRML to RML. Skip RML_OUTPUT_FILE_NAME to use the default name.
 
 Options:
-  -i, --opt-yarrrml-input-file TEXT           Use to overwrite INPUT generator
-  -o, --opt-rml-output-file TEXT              Use to overwrite OUTPUT generator
+  -i, --opt-yarrrml-input-file TEXT           Use to overwrite default INPUT generator
+  -o, --opt-rml-output-file TEXT              Use to overwrite default OUTPUT generator
   -m, --opt-mappings-path TEXT
   --help                                      Show this message and exit.
 ```
 
-#### sparql_generator
+#### CMD: sparql_generator
 Generates SPARQL queries from Conceptual Mappings file data.
 
 Use:
@@ -111,14 +113,14 @@ Usage: sparql_generator [OPTIONS] [MAPPING_SUITE_ID]
   Generates SPARQL queries from Conceptual Mappings.
 
 Options:
-  -i, --opt-conceptual-mappings-file TEXT         Use to overwrite INPUT generator
-  -o, --opt-output-sparql-queries-folder TEXT     Use to overwrite OUTPUT generator
+  -i, --opt-conceptual-mappings-file TEXT         Use to overwrite default INPUT generator
+  -o, --opt-output-sparql-queries-folder TEXT     Use to overwrite default OUTPUT generator
   -rq-name, --opt-rq-name TEXT
   -m, --opt-mappings-path TEXT
   --help                                          Show this message and exit.
 ```
 
-#### mapping_suite_processor
+#### CMD: mapping_suite_processor
 Processes Mapping Suite (identified by mapping-suite-id).
 
 Successively runs the following commands:
@@ -143,7 +145,7 @@ Options:
   --help                                      Show this message and exit.
 ```
 
-#### transformer
+#### CMD: transformer
 Transforms the Test Mapping Suites.
 
 Use:

diff --git a/ted_sws/data_manager/entrypoints/cmd_generate_mapping_resources.py b/ted_sws/data_manager/entrypoints/cmd_generate_mapping_resources.py
@@ -87,8 +87,9 @@ def run(mapping_suite_id=None,
 
 @click.command()
 @click.argument('mapping-suite-id', nargs=1, required=False)
-@click.option('--opt-queries-folder', default=str(QUERIES_PATH))
-@click.option('--opt-output-folder', default=str(MAPPING_FILES_PATH))
+@click.option('-i', '--opt-queries-folder', default=str(QUERIES_PATH), help="Use to overwrite default INPUT generator")
+@click.option('-o', '--opt-output-folder', default=str(MAPPING_FILES_PATH),
+              help="Use to overwrite default OUTPUT generator")
 @click.option('-m', '--opt-mappings-path', default=DEFAULT_MAPPINGS_PATH)
 def main(mapping_suite_id, opt_queries_folder, opt_output_folder, opt_mappings_path):
     run(mapping_suite_id, opt_queries_folder, opt_output_folder, opt_mappings_path, SPARQLTripleStore())

diff --git a/ted_sws/mapping_suite_processor/entrypoints/cmd_metadata_generator.py b/ted_sws/mapping_suite_processor/entrypoints/cmd_metadata_generator.py
@@ -86,8 +86,8 @@ def run(mapping_suite_id=None, opt_conceptual_mappings_file=None, opt_output_met
 
 @click.command()
 @click.argument('mapping-suite-id', nargs=1, required=False)
-@click.option('-i', '--opt-conceptual-mappings-file', help="Use to overwrite INPUT generator")
-@click.option('-o', '--opt-output-metadata-file', help="Use to overwrite OUTPUT generator")
+@click.option('-i', '--opt-conceptual-mappings-file', help="Use to overwrite default INPUT generator")
+@click.option('-o', '--opt-output-metadata-file', help="Use to overwrite default OUTPUT generator")
 @click.option('-m', '--opt-mappings-path', default=DEFAULT_MAPPINGS_PATH)
 def main(mapping_suite_id, opt_conceptual_mappings_file, opt_output_metadata_file, opt_mappings_path):
     """

diff --git a/ted_sws/mapping_suite_processor/entrypoints/cmd_sparql_generator.py b/ted_sws/mapping_suite_processor/entrypoints/cmd_sparql_generator.py
@@ -87,8 +87,8 @@ def run(mapping_suite_id=None, opt_conceptual_mappings_file=None, opt_output_spa
 
 @click.command()
 @click.argument('mapping-suite-id', nargs=1, required=False)
-@click.option('-i', '--opt-conceptual-mappings-file', help="Use to overwrite INPUT generator")
-@click.option('-o', '--opt-output-sparql-queries-folder', help="Use to overwrite OUTPUT generator")
+@click.option('-i', '--opt-conceptual-mappings-file', help="Use to overwrite default INPUT generator")
+@click.option('-o', '--opt-output-sparql-queries-folder', help="Use to overwrite default OUTPUT generator")
 @click.option('-rq-name', '--opt-rq-name', default=DEFAULT_RQ_NAME)
 @click.option('-m', '--opt-mappings-path', default=DEFAULT_MAPPINGS_PATH)
 def main(mapping_suite_id, opt_conceptual_mappings_file, opt_output_sparql_queries_folder,

diff --git a/ted_sws/mapping_suite_processor/entrypoints/cmd_yarrrml2rml_converter.py b/ted_sws/mapping_suite_processor/entrypoints/cmd_yarrrml2rml_converter.py
@@ -91,8 +91,8 @@ def run(mapping_suite_id=None, rml_output_file_name=None, opt_yarrrml_input_file
 @click.command()
 @click.argument('mapping-suite-id', nargs=1, required=False)
 @click.argument('rml-output-file-name', nargs=1, required=False)
-@click.option('-i', '--opt-yarrrml-input-file', help="Use to overwrite INPUT generator")
-@click.option('-o', '--opt-rml-output-file', help="Use to overwrite OUTPUT generator")
+@click.option('-i', '--opt-yarrrml-input-file', help="Use to overwrite default INPUT generator")
+@click.option('-o', '--opt-rml-output-file', help="Use to overwrite default OUTPUT generator")
 @click.option('-m', '--opt-mappings-path', default=DEFAULT_MAPPINGS_PATH)
 def main(mapping_suite_id, rml_output_file_name, opt_yarrrml_input_file, opt_rml_output_file, opt_mappings_path):
     """