Install example command line tool as reporting-cli (#69)

* Install command line tool as `reporting-cli`: The command line tool
from the example is moved to the package and can be called via
`reporting-cli` or `python -m frequenz.client.reporting` from the
command line.
* The command-line argument `--display` is renamed to `--format` for
`reporting-cli`.
* The `reporting-cli` tool can output CSV format, dataframe output is
removed.

Author: cwasicki

RELEASE_NOTES.md

@@ -6,6 +6,12 @@
 
 ## Upgrading
 
+* Install command line tool as `reporting-cli`: The command line tool from the example is moved
+  to the package and can be called via `reporting-cli` or `python -m frequenz.client.reporting`
+  from the command line.
+* The command-line argument `--display` is renamed to `--format` for `reporting-cli`.
+* The `reporting-cli` tool can output CSV format, dataframe output is removed.
+
 ## New Features
 
 ## Bug Fixes

pyproject.toml

@@ -36,6 +36,9 @@ dependencies = [
 ]
 dynamic = ["version"]
 
+[project.scripts]
+reporting-cli = "frequenz.client.reporting.__main__:main"
+
 [[project.authors]]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "[email protected]"

examples/client.py renamed to src/frequenz/client/reporting/__main__.py

@@ -9,12 +9,9 @@
 from pprint import pprint
 from typing import AsyncIterator
 
-import pandas as pd
 from frequenz.client.common.metric import Metric
 
 from frequenz.client.reporting import ReportingApiClient
-
-# Experimental import
 from frequenz.client.reporting._client import MetricSample
 
 
@@ -52,7 +49,7 @@ def main() -> None:
     parser.add_argument("--resolution", type=int, help="Resolution", default=None)
     parser.add_argument("--psize", type=int, help="Page size", default=1000)
     parser.add_argument(
-        "--display", choices=["iter", "df", "dict"], help="Display format", default="df"
+        "--format", choices=["iter", "csv", "dict"], help="Output format", default="csv"
     )
     parser.add_argument(
         "--key",
@@ -72,7 +69,7 @@ def main() -> None:
             page_size=args.psize,
             service_address=args.url,
             key=args.key,
-            display=args.display,
+            fmt=args.format,
         )
     )
 
@@ -88,7 +85,7 @@ async def run(
     page_size: int,
     service_address: str,
     key: str,
-    display: str,
+    fmt: str,
 ) -> None:
     """Test the ReportingApiClient.
 
@@ -102,10 +99,10 @@ async def run(
         page_size: page size
         service_address: service address
         key: API key
-        display: display format
+        fmt: output format
 
     Raises:
-        ValueError: if display format is invalid
+        ValueError: if output format is invalid
     """
     client = ReportingApiClient(service_address, key)
 
@@ -129,26 +126,25 @@ def data_iter() -> AsyncIterator[MetricSample]:
             page_size=page_size,
         )
 
-    if display == "iter":
+    if fmt == "iter":
         # Iterate over single metric generator
         async for sample in data_iter():
             print(sample)
 
-    elif display == "dict":
+    elif fmt == "dict":
         # Dumping all data as a single dict
         dct = await iter_to_dict(data_iter())
         pprint(dct)
 
-    elif display == "df":
-        # Turn data into a pandas DataFrame
-        data = [cd async for cd in data_iter()]
-        df = pd.DataFrame(data).set_index("timestamp")
-        # Set option to display all rows
-        pd.set_option("display.max_rows", None)
-        pprint(df)
+    elif fmt == "csv":
+        # Print header
+        print(",".join(MetricSample._fields))
+        # Iterate over single metric generator and format as CSV
+        async for sample in data_iter():
+            print(",".join(str(e) for e in sample))
 
     else:
-        raise ValueError(f"Invalid display format: {display}")
+        raise ValueError(f"Invalid output format: {fmt}")
 
     return