feat: create the CLI command flexmeasures show reporters (#686)

* feat: create show reporter command Signed-off-by: Victor Garcia Reolid <victor@seita.nl> * style: add hint to list reporters Signed-off-by: Victor Garcia Reolid <victor@seita.nl> * style: add module name style: print empty string when the author is missing Signed-off-by: Victor Garcia Reolid <victor@seita.nl> * style: change column order Signed-off-by: Victor Garcia Reolid <victor@seita.nl> * docs: add entry for PR #686 Signed-off-by: Victor Garcia Reolid <victor@seita.nl> * docs: add command flexmeasures show reporters Signed-off-by: Victor Garcia Reolid <victor@seita.nl> --------- Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
FlexMeasures · May 19, 2023 · c412802 · c412802
1 parent 1a73c1a
commit c412802
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/documentation/changelog.rst b/documentation/changelog.rst
@@ -10,6 +10,7 @@ New features
 -------------
 
 * Introduction of the classes `Reporter` and `PandasReporter` [see `PR #641 <https://www.github.com/FlexMeasures/flexmeasures/pull/641>`_]
+* Add CLI command ``flexmeasures show reporters`` [see `PR #686 <https://www.github.com/FlexMeasures/flexmeasures/pull/686>`_]
 
 
 Bugfixes

diff --git a/documentation/cli/commands.rst b/documentation/cli/commands.rst
@@ -53,6 +53,7 @@ of which some are referred to in this documentation.
 ``flexmeasures show roles``                       List available account- and user roles.
 ``flexmeasures show data-sources``                List available data sources.
 ``flexmeasures show beliefs``                     Plot time series data.
+``flexmeasures show reporters``                   List available reporters.
 ================================================= =======================================
 
 

diff --git a/flexmeasures/cli/data_add.py b/flexmeasures/cli/data_add.py
@@ -1133,7 +1133,8 @@ def add_schedule_for_storage(
     default="PandasReporter",
     required=True,
     type=click.STRING,
-    help="Reporter class registered in flexmeasures.data.models.reporting or in an available flexmeasures plugin.",
+    help="Reporter class registered in flexmeasures.data.models.reporting or in an available flexmeasures plugin."
+    " Use the command `flexmeasures show reporters` to list all the available reporters.",
 )
 @click.option(
     "--sensor-id",

diff --git a/flexmeasures/cli/data_show.py b/flexmeasures/cli/data_show.py
@@ -376,4 +376,28 @@ def plot_beliefs(
         click.secho("Data saved to file.", **MsgStyle.SUCCESS)
 
 
+@fm_show_data.command("reporters")
+@with_appcontext
+def list_reporters():
+    """
+    Show available reporters.
+    """
+
+    click.echo("Reporters:\n")
+    click.echo(
+        tabulate(
+            [
+                (
+                    reporter_name,
+                    reporter_class.__version__,
+                    reporter_class.__author__,
+                    reporter_class.__module__,
+                )
+                for reporter_name, reporter_class in app.reporters.items()
+            ],
+            headers=["name", "version", "author", "module"],
+        )
+    )
+
+
 app.cli.add_command(fm_show_data)