update scripts to support command line arguments

build/build_other_doc_header.py

@@ -1,28 +1,50 @@
-# Script to build Markdown pages that provide term metadata for complex vocabularies
+# Script to insert header metadata into a document template
-# Steve Baskauf 2020-06-28 CC0
+# This program is released under a GNU General Public License v3.0 http://www.gnu.org/licenses/gpl-3.0
-# Modified for use with Humboldt Extension 2022-05-29
+# Author: Steve Baskauf
-# This script merges static Markdown header and footer documents with term information tables (in Markdown) generated from data in the rs.tdwg.org repo from the TDWG Github site
 
-import re
+script_version = '0.1.0'
-import requests   # best library to manage HTTP transactions
+version_modified = '2023-09-17'
-import csv        # library to read/write/parse CSV files
+
-import json       # library to convert JSON to Python data structures
+# NOTE: This script should be run after the script that moves the previous document to a version.
+
+import requests
 import pandas as pd
 import yaml
+import sys
+
+# -----------------
+# Command line arguments
+# -----------------
+
+arg_vals = sys.argv[1:]
+opts = [opt for opt in arg_vals if opt.startswith('-')]
+args = [arg for arg in arg_vals if not arg.startswith('-')]
+
+# Name of the last part of the URL of the doc
+if '--slug' in opts:
+    document_slug = args[opts.index('--slug')]
+else:
+    print('Must specify URL slug for document using --slug option')
+    exit()
+
+# Used as the directory name
+if '--dir' in opts:
+    directory_name = args[opts.index('--dir')]
+else:
+    print('Must specify name of directory containing template and configs using --dir option')
+    exit()
+
+# "master" for production, something else for development
+if '--branch' in opts:
+    github_branch = args[opts.index('--branch')]
+else:
+    github_branch = 'master'
+
 
 # -----------------
 # Configuration section
 # -----------------
 
-# Name of the last part of the URL of the doc
-document_slug = 'text'
-
-# Used as the directory name
-directory_name = 'dwc_terms_guides_text'
-
-# "master" for production, something else for development
-github_branch = 'master'
-
 # This is the base URL for raw files from the branch of the repo that has been pushed to GitHub
 github_base_url = 'https://raw.githubusercontent.com/tdwg/rs.tdwg.org/' + github_branch + '/'
 

build/update_previous_doc.py

@@ -1,18 +1,58 @@
 # Script to make the current document be the previous document
+# This program is released under a GNU General Public License v3.0 http://www.gnu.org/licenses/gpl-3.0
+# Author: Steve Baskauf
 
-# This script should be run only after the script updating the machine-readable metadata has been run.
+script_version = '0.1.0'
+version_modified = '2023-09-17'
 
-import requests   # best library to manage HTTP transactions
+# NOTE: This script should be run only after the script updating the machine-readable metadata has been run.
+# It must be run before the script that generates the new document version.
+
+import requests
 import pandas as pd
 import yaml
 import os
+import sys
 
-githubBaseUri = 'https://raw.githubusercontent.com/tdwg/rs.tdwg.org/master/'
+# -----------------
+# Command line arguments
+# -----------------
 
-config_file_path = 'process/document_metadata_processing/dwc_terms_guides_text/'
+arg_vals = sys.argv[1:]
+opts = [opt for opt in arg_vals if opt.startswith('-')]
+args = [arg for arg in arg_vals if not arg.startswith('-')]
+
+# Name of the last part of the URL of the doc
+if '--slug' in opts:
+    document_slug = args[opts.index('--slug')]
+else:
+    print('Must specify URL slug for document using --slug option')
+    exit()
+
+# Used as the directory name
+if '--dir' in opts:
+    directory_name = args[opts.index('--dir')]
+else:
+    print('Must specify name of directory containing template and configs using --dir option')
+    exit()
+
+# "master" for production, something else for development
+if '--branch' in opts:
+    github_branch = args[opts.index('--branch')]
+else:
+    github_branch = 'master'
+
+
+# -----------------
+# Configuration section
+# -----------------
+
+githubBaseUri = 'https://raw.githubusercontent.com/tdwg/rs.tdwg.org/' + github_branch + '/'
+
+config_file_path = 'process/document_metadata_processing/' + directory_name + '/'
 document_configuration_yaml_file = 'document_configuration.yaml'
 
-path_of_doc_relative_to_build_dir = '../docs/text/'
+path_of_doc_relative_to_build_dir = '../docs/' + document_slug + '/'
 
 # Load the document configuration YAML file from its GitHub URL
 document_configuration_yaml_url = githubBaseUri + config_file_path + document_configuration_yaml_file