Merge pull request #490 from MetOffice/launch-tutorial

add sub commands to make tutorial easier to use

Author: andrewgryan

doc/source/start.rst

@@ -42,16 +42,24 @@ to hands on experience.
 
    ~: forest tutorial --help
 
-The only argument `forest-tutorial` needs is a directory to place
-files. Go ahead and run the tutorial command to
+The only argument `forest tutorial files` needs is a directory to place
+files into. Go ahead and run the tutorial command to
 get your hands on some files that `forest` can analyse.
 
 .. code-block:: bash
 
-   ~: forest tutorial .
+   ~: forest tutorial files .
 
 The above snippet can be used to populate the current working directory with
-all of the inputs needed to run the `forest` command line interface
+all of the inputs needed to run the `forest` command line interface.
+
+If you get stuck and want a quick way to open the tutorial page.
+
+.. code-block:: bash
+
+   ~: forest tutorial launch
+
+The launch command opens a browser tab at the official tutorial guide.
 
 Example - Unified model output
 ------------------------------

forest/cli/alternative.py

@@ -14,6 +14,21 @@
 
 app = typer.Typer(help="Command line interface for FOREST web application")
 
+# Tutorial sub-command
+tutorial_app = typer.Typer(help="Guide to getting started")
+app.add_typer(tutorial_app, name="tutorial")
+tutorial_app.command(name="files")(forest.tutorial.main.main)
+
+
+@tutorial_app.command()
+def launch():
+    """Open documentation pages"""
+    typer.secho("Opening tutorial page...\n", fg=typer.colors.CYAN)
+    typer.launch(
+        "https://forest-informaticslab.readthedocs.io/en/latest/start.html#tutorial"
+    )
+
+
 # Driver sub-command
 driver_app = typer.Typer(help="Describe available drivers")
 app.add_typer(driver_app, name="driver")
@@ -134,9 +149,6 @@ def ctl(
     return subprocess.call(command)
 
 
-app.command(name="tutorial")(forest.tutorial.main.main)
-
-
 app.command(name="db")(forest.db.main.main)
 
 

test/test_tutorial.py

@@ -34,7 +34,7 @@ def test_main_calls_build_all_with_build_dir(build_dir, file_names):
     if isinstance(file_names, str):
         file_names = [file_names]
 
-    runner.invoke(app, ["tutorial", build_dir])
+    runner.invoke(app, ["tutorial", "files", build_dir])
 
     for file_name in file_names:
         assert os.path.exists(os.path.join(build_dir, file_name)), file_name