MRG: Merge pull request #734 from octue/switch-to-octue-twined-cli

Switch to octue twined CLI

Author: cortadocodes

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 exclude: "build|.git/|.tox|dist|octue.egg-info"
 default_stages: [commit]
-fail_fast: true
+fail_fast: false
 default_language_version:
   python: python3 # force all unspecified python hooks to run python3
 repos:

docs/source/creating_services.rst

@@ -126,7 +126,7 @@ See :ref:`here <service_naming>` for service naming requirements.
 - Set in:
 
   - ``OCTUE_SERVICE_REVISION_TAG`` environment variable
-  - If using ``octue start`` command, the ``--revision-tag`` option (takes priority)
+  - If using ``octue twined start`` command, the ``--revision-tag`` option (takes priority)
 
 
 Template apps

docs/source/inter_service_compatibility.rst

@@ -24,7 +24,7 @@ Via the CLI
 
     .. code-block:: shell
 
-        octue question ask local --input-values='{"some": "input"}'
+        octue twined question ask local --input-values='{"some": "input"}'
 
 The output values and/or manifest will be printed to ``stdout`` but are also stored in the event store.
 
@@ -61,7 +61,7 @@ Via the CLI
 
     .. code-block:: shell
 
-        octue start
+        octue twined start
 
 This will run the service as a child waiting for questions until you press ``Ctrl + C`` or an error is encountered. The
 service will be available to be questioned by other services at the service ID ``organisation/name`` as specified in

docs/source/running_services_locally.rst

@@ -27,15 +27,15 @@ message. A user with credentials to access this path can use the ``octue`` CLI t
 
 .. code-block:: shell
 
-    octue question diagnostics <cloud-path>
+    octue twined question diagnostics <cloud-path>
 
 More information on the command:
 
 .. code-block::
 
-    >>> octue question diagnostics -h
+    >>> octue twined question diagnostics -h
 
-    Usage: octue question diagnostics [OPTIONS] CLOUD_PATH
+    Usage: octue twined question diagnostics [OPTIONS] CLOUD_PATH
 
       Download diagnostics for an analysis from the given directory in
       Google Cloud Storage. The cloud path should end in the analysis ID.

docs/source/troubleshooting_services.rst

@@ -10,10 +10,10 @@
 
 from octue.cloud import storage
 from octue.cloud.events.answer_question import answer_question
-from octue.cloud.events.replayer import EventReplayer
 from octue.cloud.events.question import make_question_event
+from octue.cloud.events.replayer import EventReplayer
 from octue.cloud.events.validation import VALID_EVENT_KINDS
-from octue.cloud.pub_sub.bigquery import get_events, DEFAULT_EVENT_STORE_TABLE_ID
+from octue.cloud.pub_sub.bigquery import DEFAULT_EVENT_STORE_TABLE_ID, get_events
 from octue.cloud.pub_sub.service import Service
 from octue.cloud.service_id import create_sruid, get_sruid_parts
 from octue.cloud.storage import GoogleCloudStorageClient
@@ -32,13 +32,6 @@
 
 
 @click.group(context_settings={"help_option_names": ["-h", "--help"]})
-@click.option(
-    "--id",
-    default=None,
-    type=click.UUID,
-    show_default=True,
-    help="UUID of the analysis being undertaken. None (for local use) will cause a unique ID to be generated.",
-)
 @click.option("--logger-uri", default=None, show_default=True, help="Stream logs to a websocket at the given URI.")
 @click.option(
     "--log-level",
@@ -47,25 +40,15 @@
     show_default=True,
     help="Log level used for the analysis.",
 )
-@click.option(
-    "--force-reset/--no-force-reset",
-    default=True,
-    is_flag=True,
-    show_default=True,
-    help="Forces a reset of analysis cache and outputs [For future use, currently not implemented]",
-)
 @click.version_option(version=LOCAL_SDK_VERSION)
-def octue_cli(id, logger_uri, log_level, force_reset):
-    """The CLI for the Octue SDK. Use it to start an Octue data service or digital twin locally or run an analysis on
-    one locally.
+def octue_cli(logger_uri, log_level):
+    """The CLI for Octue SDKs and APIs, most notably Twined.
 
     Read more in the docs: https://octue-python-sdk.readthedocs.io/en/latest/
     """
-    global_cli_context["analysis_id"] = id
     global_cli_context["logger_uri"] = logger_uri
     global_cli_context["log_handler"] = None
     global_cli_context["log_level"] = log_level.upper()
-    global_cli_context["force_reset"] = force_reset
 
     apply_log_handler(log_level=log_level.upper())
 
@@ -74,6 +57,12 @@ def octue_cli(id, logger_uri, log_level, force_reset):
 
 
 @octue_cli.group()
+def twined():
+    """The Twined CLI. Use it to ask questions to or start a Twined data service in the cloud or locally."""
+    pass
+
+
+@twined.group()
 def question():
     """Ask a new question to an Octue Twined data service or interact with a previous question."""
 
@@ -322,7 +311,7 @@ def get(
     limit,
     service_config,
 ):
-    """Get the events emitted during a question as JSON. One of the following must be set:
+    r"""Get the events emitted during a question as JSON. One of the following must be set:
 
     --question-uuid\n
     --parent-question-uuid\n
@@ -434,7 +423,7 @@ def replay(
     exclude_logs_containing,
     validate_events,
 ):
-    """Replay a question's events, returning the result as JSON at the end if there is one. One of the following must be
+    r"""Replay a question's events, returning the result as JSON at the end if there is one. One of the following must be
     set:
 
     --question-uuid\n
@@ -584,29 +573,7 @@ def diagnostics(cloud_path, local_path, download_datasets):
 #     child.cancel(question_uuid=question_uuid, event_store_table_id=service_configuration.event_store_table_id)
 
 
-@octue_cli.command(deprecated=True)
-@click.argument(
-    "cloud_path",
-    type=str,
-)
-@click.option(
-    "--local-path",
-    type=click.Path(file_okay=False),
-    default=".",
-    help="The path to a directory to store the directory of diagnostics data in. Defaults to the current working "
-    "directory.",
-)
-@click.option(
-    "--download-datasets",
-    is_flag=True,
-    help="If provided, download any datasets from the diagnostics and update their paths in the configuration and "
-    "input manifests to the new local paths.",
-)
-def get_diagnostics(cloud_path, local_path, download_datasets):
-    diagnostics(cloud_path, local_path, download_datasets)
-
-
-@octue_cli.command()
+@twined.command()
 @click.option(
     "-c",
     "--service-config",