[fl] feat: add support for writing dashboard sources

Change-Id: I93d8ff2fd8d8da7b1e70692f39c8ae4a39f4d3a2

Author: AndreyMarkinPPC

docs/get-started/quickstart.md

@@ -54,7 +54,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -118,7 +118,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash  hl_lines="10"
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -174,7 +174,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash hl_lines="8-10"
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -231,7 +231,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash hl_lines="8-10"
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -294,7 +294,7 @@ creative_map.save('creative_map')
 Expose `MEDIA_TAGGING_DB_URL` environmental variable and restart service.
 ```bash
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -344,7 +344,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash hl_lines="11"
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -360,7 +360,68 @@ curl -X 'POST' \
 
 ### Output
 
-By default the results are saved into `creative_map.json` file in the current folder.
+By default the after running `filonov` you get a JSON file (`creative_map.json`) that contains all necessary information to visualize the results.
+
+
+#### Dashboardgenerate:
+
+/// tab | cli
+```bash hl_lines="4-5"
+filonov --source googleads --media-type IMAGE \
+  --tagger gemini \
+  --googleads.account=GOOGLE_ADS_ACCOUNT_ID \
+  --output dashboard --writer bq \
+  --bq.project=BQ_PROJECT --bq.dataset=BQ_DATASETgenerate:
+```
+///
+
+/// tab | python
+
+```python hl_lines="10-20"
+import filonov
+
+service = filonov.FilonovService()
+
+request = filonov.CreativeMapGenerateRequest(
+  source='googleads',
+  media_type='IMAGE',
+  tagger='gemini',
+  source_parameters={'account': 'GOOGLE_ADS_ACCOUNT_ID'},
+  output_parameters={'output': 'dashboard'},
+)
+
+service.generate_dashboard(
+  request,
+  writer='bq',
+  writer_parameters={
+    'project': 'BQ_PROJECT',
+    'dataset': 'BQ_DATASET'
+  }
+)
+
+```
+///
+
+/// tab | curl
+```bash hl_lines="11-13"
+curl -X 'POST' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
+  -H 'accept: application/json' \
+  -H 'Content-Type: application/json' \
+  -d '{
+  "media_type": "IMAGE",
+  "tagger": "gemini",
+  "source_parameters": {
+    "account": "GOOGLE_ADS_ACCOUNT_ID"
+  },
+  "output_parameters": {
+    "output": "dashboard"
+  }
+}'
+```
+///
+
+#### Map
 
 You can overwrite it with `output-name` option.
 
@@ -401,7 +462,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash hl_lines="11-13"
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{
@@ -464,7 +525,7 @@ creative_map.save('creative_map')
 /// tab | curl
 ```bash hl_lines="11"
 curl -X 'POST' \
-  'http://127.0.0.1:8000/creative_maps/generate:googleads' \
+  'http://127.0.0.1:8000/filonov/creative_map/googleads' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{

libs/filonov/filonov/__init__.py

@@ -20,12 +20,17 @@
 """
 
 from filonov.creative_map import CreativeMap
-from filonov.filonov_service import CreativeMapGenerateRequest, FilonovService
+from filonov.filonov_service import (
+  FilonovService,
+  GenerateCreativeMapRequest,
+  GenerateDashboardRequest,
+)
 
 __all__ = [
   'FilonovService',
-  'CreativeMapGenerateRequest',
+  'GenerateCreativeMapRequest',
+  'GenerateDashboardRequest',
   'CreativeMap',
 ]
 
-__version__ = '0.9.0'
+__version__ = '0.10.0'

libs/filonov/filonov/entrypoints/cli.py

@@ -71,6 +71,18 @@ def main(
       case_sensitive=False,
     ),
   ] = None,
+  output: Annotated[
+    str,
+    typer.Option(
+      help='Type of output',
+    ),
+  ] = 'map',
+  writer: Annotated[
+    str,
+    typer.Option(
+      help='Type of writer',
+    ),
+  ] = 'csv',
   output_name: Annotated[
     str,
     typer.Option(
@@ -143,7 +155,7 @@ def main(
     media_fetching.enrichers.enricher.AVAILABLE_MODULES.keys()
   )
   parsed_param_keys = set(
-    [source, 'tagger', 'similarity'] + list(supported_enrichers)
+    [source, 'tagger', 'similarity', writer] + list(supported_enrichers)
   )
   extra_parameters = garf_utils.ParamsParser(parsed_param_keys).parse(ctx.args)
   fetching_service = media_fetching.MediaFetchingService.from_source_alias(
@@ -179,33 +191,44 @@ def main(
   if source == 'youtube':
     media_type = 'YOUTUBE_VIDEO'
     tagger = 'gemini'
-  request = filonov.CreativeMapGenerateRequest(
-    source=source,
-    media_type=media_type,
-    tagger=tagger,
-    tagger_parameters=extra_parameters.get('tagger'),
-    similarity_parameters=extra_parameters.get('similarity'),
-    source_parameters=extra_parameters.get(source),
-    output_parameters=filonov.filonov_service.OutputParameters(
-      output_name=output_name
-    ),
-    parallel_threshold=parallel_threshold,
-    trim_tags_threshold=trim_tags_threshold,
-    embed_previews=embed_previews,
-    omit_series=omit_series,
-    context=extra_parameters,
-  )
-  span.set_attribute(
-    'filonov.cli.command', utils.build_cli_command(request, db_uri)
-  )
+  params = {
+    'source': source,
+    'media_type': media_type,
+    'tagger': tagger,
+    'tagger_parameters': extra_parameters.get('tagger'),
+    'similarity_parameters': extra_parameters.get('similarity'),
+    'source_parameters': extra_parameters.get(source),
+    'parallel_threshold': parallel_threshold,
+    'trim_tags_threshold': trim_tags_threshold,
+    'context': extra_parameters,
+  }
   filonov_service = filonov.FilonovService(
     fetching_service, tagging_service, similarity_service
   )
-  generated_map = filonov_service.generate_creative_map(request)
-  destination = utils.build_creative_map_destination(
-    request.output_parameters.output_name
+  if output == 'dashboard':
+    request = filonov.GenerateDashboardRequest(
+      **params,
+      writer=writer,
+      writer_parameters=extra_parameters.get(writer, {}),
+    )
+    filonov_service.generate_dashboard(request)
+  else:
+    request = filonov.GenerateCreativeMapRequest(
+      **params,
+      output_parameters=filonov.filonov_service.OutputParameters(
+        output_name=output_name
+      ),
+      embed_previews=embed_previews,
+      omit_series=omit_series,
+    )
+    generated_map = filonov_service.generate_creative_map(request)
+    destination = utils.build_creative_map_destination(
+      request.output_parameters.output_name
+    )
+    generated_map.save(destination)
+  span.set_attribute(
+    'filonov.cli.command', utils.build_cli_command(request, db_uri)
   )
-  generated_map.save(destination)
 
 
 if __name__ == '__main__':