feat: create the CLI command flexmeasures show reporters

.vscode/spellright.dict

@@ -246,8 +246,8 @@ deserializing
 kwargs
 fsdomain
 filepath
+spellright
 Changelog
 Bugfixes
 Dockerfile
-―
 nt

documentation/dev/introduction.rst

@@ -1,6 +1,7 @@
 .. _developing:
 
 
+
 Developing for FlexMeasures
 ===========================
 
@@ -36,8 +37,6 @@ Clone the `FlexMeasures repository <https://github.com/FlexMeasures/flexmeasures
 
    $ git clone https://github.com/FlexMeasures/flexmeasures.git
 
-.. note:: Are you using Visual Studio Code? Then the code you just cloned also contains the editor configuration (part of) our team is using!
-
 
 Dependencies
 ^^^^^^^^^^^^^^^^^^^^
@@ -211,6 +210,23 @@ If ``flake8``, ``black`` or ``mypy`` propose changes to any file, the commit is
 The changes proposed by ``black`` are implemented automatically (you can review them with `git diff`). Some of them might even resolve the ``flake8`` warnings :)
 
 
+Using Visual Studio, including spell checking
+----------------------------------------------
+
+Are you using Visual Studio Code? Then the code you just cloned also contains the editor configuration (part of) our team is using (see `.vscode`)!
+
+We recommend installing the flake8 and spellright extensions.
+
+For spellright, the FlexMeasures repository contains the project dictionary. Here are steps to link main dictionaries, which usually work on a Linux system:
+
+.. code-block:: bash
+
+   $ mkdir $HOME/.config/Code/Dictionaries
+   $ ln -s /usr/share/hunspell/* ~/.config/Code/Dictionaries
+
+Consult the extension's Readme for other systems.
+
+
 
 A hint about using notebooks
 ---------------

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",

flexmeasures/cli/data_show.py

@@ -376,4 +376,27 @@ 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__,
+                    str(reporter_class.__author__),
+                )
+                for reporter_name, reporter_class in app.reporters.items()
+            ],
+            headers=["name", "version", "author"],
+        )
+    )
+
+
 app.cli.add_command(fm_show_data)