20 set up cli

meorg_client/cli.py

@@ -0,0 +1,285 @@
+"""Command Line Interface"""
+import click
+from meorg_client.client import Client
+import meorg_client.utilities as mcu
+import os
+import sys
+from inspect import getmembers
+import getpass
+from pathlib import Path
+import json
+
+
+def _get_client():
+    """Get an authenticated client.
+
+    Returns
+    -------
+    meorg_client.client.Client
+        Client object.
+    """
+    # Get the dev-mode flag from the environment, better than passing the dev flag everywhere.
+    dev_mode = os.getenv("MEORG_DEV_MODE", "0") == "1"
+
+    credentials = mcu.get_user_data_filepath('credentials.json')
+    credentials_dev = mcu.get_user_data_filepath('credentials-dev.json')
+
+    # In dev mode and the configuration file exists
+    if dev_mode and credentials_dev.is_file():
+        credentials = mcu.load_user_data('credentials-dev.json')
+
+    # In dev mode and it doesn't (i.e. Actions)
+    elif dev_mode and not credentials_dev.is_file():
+        credentials = dict(
+            email=os.getenv('MEORG_EMAIL'),
+            password=os.getenv('MEORG_PASSWORD')
+        )
+
+    # Production credentials
+    else:
+        credentials = mcu.load_user_data("credentials.json")
+
+    # Get the client
+    return Client(
+        email=credentials["email"], password=credentials["password"], dev_mode=dev_mode
+    )
+
+
+def _call(func, **kwargs):
+    """Simple wrapper to handle exceptions.
+
+    Exceptions are captured broadly and raw error message printed before non-zero exit.
+
+    Parameters
+    ----------
+    func : callable
+        Method to call.
+    **kwargs :
+        Additional arguments to method.
+
+    Returns
+    -------
+    dict
+        Response dictionary.
+    """
+    try:
+        return func(**kwargs)
+    except Exception as ex:
+
+        click.echo(ex.msg, err=True)
+
+        # Bubble up the exception
+        if os.getenv('MEORG_DEV_MODE') == '1':
+            raise
+
+        sys.exit(1)
+
+
+@click.group()
+def cli():
+    """
+    ModelEvaluation.org client utility.
+
+    For more detail run:
+    meorg [SUBCOMMAND] --help
+    """
+    pass
+
+
+@click.command('list')
+def list_endpoints():
+    """
+    List the available endpoints for the server.
+    """
+    client = _get_client()
+    endpoints = _call(client.list_endpoints)
+
+    for url, config in endpoints.get("paths").items():
+        for method in config.keys():
+            out = " ".join(
+                [
+                    method.upper(),
+                    url,
+                    endpoints.get("paths")[url][method]["description"],
+                ]
+            )
+
+            click.echo(out)
+
+
+@click.command('status')
+@click.argument("id")
+def file_status(id):
+    """
+    Check the file status based on the job ID from file-upload.
+
+    Prints the true file ID or a status.
+    """
+    client = _get_client()
+    response_data = _call(client.get_file_status, id=id).get("data")
+
+    # If the file is complete (transferred to object store), get the true ID
+    if response_data.get("status") == "complete":
+        file_id = response_data.get("files")[0].get("file")
+        click.echo(file_id)
+    else:
+        click.echo("Pending")
+
+
+@click.command('upload')
+@click.argument("file_path")
+def file_upload(file_path):
+    """
+    Upload a file to the server.
+
+    Prints Job ID on success, which is used by file-status to check transfer status.
+    """
+    client = _get_client()
+
+    # Upload the file, get the job ID
+    response = _call(client.upload_file, file_path=file_path)
+    job_id = response.get("data").get("jobId")
+    click.echo(job_id)
+
+
+@click.command('list')
+@click.argument("id")
+def file_list(id):
+    """
+    List the files currently attached to a model output.
+
+    Prints 1 File ID per line.
+    """
+    client = _get_client()
+    response = _call(client.list_files, id=id)
+
+    for f in response.get("data").get("files"):
+        click.echo(f)
+
+
+@click.command('attach')
+@click.argument("file_id")
+@click.argument("output_id")
+def file_attach(file_id, output_id):
+    """
+    Attach a file to a model output.
+    """
+    client = _get_client()
+
+    response = _call(client.attach_files_to_model_output, id=output_id, files=[file_id])
+
+    click.echo("SUCCESS")
+
+
+@click.command('start')
+@click.argument("id")
+def analysis_start(id):
+    """
+    Start the analysis for the model output id.
+
+    Prints the Analysis ID, which can be used in analysis-status.
+    """
+    client = _get_client()
+
+    response = _call(client.start_analysis, id=id)
+
+    if client.success():
+        analysis_id = response.get("data").get("analysisId")
+        click.echo(analysis_id)
+
+
+@click.command('status')
+@click.argument("id")
+def analysis_status(id):
+    """
+    Get the status of the analysis.
+
+    Prints the status of the analysis and the URL to the dashboard.
+    """
+    client = _get_client()
+    response = _call(client.get_analysis_status, id=id)
+    status = response.get("status")
+
+    # Error case
+    if status == "error":
+        click.echo(response.get("message"), err=True)
+        sys.exit(1)
+
+    # Get the status out of the data object
+    status = response.get("data").get("status")
+    url = response.get("data").get("url")
+
+    click.echo(status)
+    click.echo(url)
+
+
+@click.command()
+@click.option(
+    "--dev", is_flag=True, default=False, help="Setup for the development server."
+)
+def initialise(dev=False):
+    """
+    Initialise the client on the system.
+    """
+    email = input("Enter your email for modelevaluation.org: ")
+    password = getpass.getpass("Enter your password for modelevaluation.org: ")
+
+    click.echo("Testing connection...")
+    client = Client(dev_mode=dev)
+
+    try:
+        client.login(email, password)
+    except Exception as ex:
+        click.echo("Unable to establish connection to server.", err=True)
+        click.echo(ex.msg, err=True)
+        sys.exit(1)
+
+    print("Connection established.")
+
+    # Build out the dictionary and save it to the user home.
+    credentials = dict(email=email, password=password)
+
+    filename = "credentials.json" if not dev else "credentials-dev.json"
+
+    cred_dir = Path.home() / ".meorg"
+    cred_dir.mkdir(parents=True, exist_ok=True)
+    cred_filepath = cred_dir / filename
+    json.dump(credentials, open(cred_filepath, "w"), indent=4)
+
+    click.echo("Credentials written to " + str(cred_filepath))
+
+
+# Add groups for nested subcommands
+@click.group('endpoints', help='API endpoint commands.')
+def cli_endpoints():
+    pass
+
+@click.group('file', help='File commands.')
+def cli_file():
+    pass
+
+@click.group('analysis', help='Analysis commands.')
+def cli_analysis():
+    pass
+
+# Add file commands
+cli_file.add_command(file_list)
+cli_file.add_command(file_upload)
+cli_file.add_command(file_status)
+cli_file.add_command(file_attach)
+
+# Add endpoint commands
+cli_endpoints.add_command(list_endpoints)
+
+# Add analysis commands
+cli_analysis.add_command(analysis_start)
+cli_analysis.add_command(analysis_status)
+
+# Add subparsers to the master
+cli.add_command(cli_endpoints)
+cli.add_command(cli_file)
+cli.add_command(cli_analysis)
+
+
+if __name__ == "__main__":
+    cli()

meorg_client/client.py

@@ -32,8 +32,13 @@ def __init__(self, email: str = None, password: str = None, dev_mode: bool = Fal
         # Initialise the mimetypes
         mt.init()
 
-        # Set base_url for the API
-        self.base_url = mcc.MEORG_BASE_URL_PROD if dev_mode == False else os.getenv('MEORG_BASE_URL_DEV', None)
+        # Dev mode can be set by the user or from the environment
+        dev_mode = dev_mode or os.getenv("MEORG_DEV_MODE", "0") == "1"
+
+        if dev_mode:
+            self.base_url = os.getenv("MEORG_BASE_URL_DEV", None)
+        else:
+            self.base_url = mcc.MEORG_BASE_URL_PROD
 
         self.headers = {"Cache-Control": "no-cache", "Pragma": "no-cache"}
         self.last_response = None

meorg_client/constants.py

@@ -16,4 +16,4 @@
 HTTP_STATUS_SUCCESS_RANGE = range(200, 300)
 
 # Production URL
-MEORG_BASE_URL_PROD = "https://modelevaluation.org/api"
+MEORG_BASE_URL_PROD = "https://modelevaluation.org/api"