DOC: added module doc which will be added as help message for the CLI tool

src/newcrawler/crawl.py

@@ -23,6 +23,10 @@
 # ** end header
 #
 
+"""
+Crawl a file structure using a yaml cfood definition and synchronize
+the acuired data with CaosDB.
+"""
 
 import sys
 import os
@@ -710,14 +714,14 @@ def main():
 def parse_args():
     parser = argparse.ArgumentParser(description=__doc__,
                                      formatter_class=RawTextHelpFormatter)
-    parser.add_argument("cfood", required=True,
+    parser.add_argument("cfood",
                         help="Path name of the cfood yaml file to be used.")
     parser.add_argument("--provenance", required=False,
                         help="Path name of the provenance yaml file. "
                         "This file will only be generated if this option is set.")
     parser.add_argument("--debug", required=False, action="store_true",
                         help="Path name of the cfood yaml file to be used.")
-    parser.add_argument("path", required=True,
+    parser.add_argument("path",
                         help="The subtree of files below the given path will "
                         "be considered. Use '/' for everything.")