Convert to CLI and click app

Author: hakonhagland

python/sphinx_docs/src/opm_python_docs/download_files.py

@@ -5,6 +5,8 @@
 import subprocess
 from pathlib import Path
 
+import click
+
 URL_SIMULATORS = "https://raw.githubusercontent.com/OPM/opm-simulators/master/python/docstrings_simulators.json"
 URL_COMMON = "https://raw.githubusercontent.com/OPM/opm-common/master/python/docstrings_common.json"
 URL_DUNE_MODULE = "https://raw.githubusercontent.com/OPM/opm-simulators/master/dune.module"
@@ -25,30 +27,23 @@ def get_git_root() -> Path:
         raise RuntimeError("Not in the opm-python-documentation repository.")
     return Path(root)
 
-def convert_pr_to_commit_hash(repo: str, pr_number: str) -> str:
+def convert_pr_to_commit_hash(repo: str, pr_number: int) -> str:
     """Convert a PR number to a commit hash."""
     url = f"https://api.github.com/repos/OPM/{repo}/pulls/{pr_number}"
     response = requests.get(url)
     response.raise_for_status()
     commit_hash = response.json()["head"]["sha"]
     return commit_hash
 
-def download_docstring_file(url: str) -> None:
+def download_docstring_file(url: str, pr_number: int|None) -> None:
     """Download a docstrings file from a URL (either opm-simulators or opm-common)."""
     if "opm-simulators" in url:
         repo = "opm-simulators"
         filename = "docstrings_simulators.json"
     else:
         repo = "opm-common"
         filename = "docstrings_common.json"
-    print(f"Downloading docstrings file from {repo} repository. "
-           "Should we use the master branch or a PR branch?")
-    branch = input("Enter 'master' or a PR number: ")
-    if branch != "master":
-        pr_number = branch
-        if not pr_number.isdigit():
-            print("Invalid PR number.")
-            return
+    if pr_number is not None:
         commit_hash = convert_pr_to_commit_hash(repo, pr_number)
         url = url.replace("/master/", f"/{commit_hash}/")
     logging.info(f"Downloading docstrings file from {url}")
@@ -71,10 +66,35 @@ def download_dune_module() -> None:
         file.write(response.content)
     logging.info(f"Saved dune.module file to {save_path}")
 
-def main() -> None:
+# CLI command: opmdoc-download-files
+#
+# SHELL USAGE:
+#
+#  opmdoc-download-files --opm-simulators <pr-number> --opm-common <pr-number>
+#
+# DESCRIPTION:
+#
+#  Downloads the docstring JSON files from opm-simulators and opm-common. Also downloads
+#  the dune.module from opm-simulators. By default, the files are downloaded from the
+#  master branches. If a PR number is provided, the files are downloaded from the corresponding
+#  PR branch.
+#
+# EXAMPLES:
+#
+#  opmdoc-download-files   # Downloads the docstrings files and dune.module file from master branches
+#
+#  opmdoc-download-files \
+#     --opm-simulators 1234 \
+#     --opm-common 5678 # Downloads the docstrings files from PR 1234 and 5678 and dune.module from master
+#
+#
+@click.command()
+@click.option("--opm-simulators", type=int, help="PR number for opm-simulators")
+@click.option("--opm-common", type=int, help="PR number for opm-common")
+def main(opm_simulators: int|None, opm_common: int|None) -> None:
     logging.basicConfig(level=logging.INFO)
-    download_docstring_file(URL_SIMULATORS)
-    download_docstring_file(URL_COMMON)
+    download_docstring_file(URL_SIMULATORS, pr_number=opm_simulators)
+    download_docstring_file(URL_COMMON, pr_number=opm_common)
     download_dune_module()
 
 if __name__ == '__main__':