Command Line Interface#

This modules defines commands that can be called via the command line interface.

CHATSKY_DIR#

Root directory of the local chatsky installation.

DASHBOARD_DIR#

Local path to superset dashboard files to import.

DASHBOARD_SLUG = 'chatsky-stats'#

This variable stores a slug used for building the http address of the Chatsky dashboard.

DEFAULT_SUPERSET_URL = 'http://localhost:8088/'#

Default location of the Superset dashboard.

TYPE_MAPPING_CH#

Mapping of standard sql column types to Clickhouse native types.

SQL_STATEMENT_MAPPING#

Select statements for dashboard configuration with names and types represented as placeholders. The placeholder system makes queries database agnostic, required values are set during the import phase.

import_dashboard(parsed_args=None, zip_file=None)[source]#

Import an Apache Superset dashboard to a local instance with specified arguments. Before using the command, make sure you have your Superset instance up and running: ghcr.io/deeppavlov/superset_df_dashboard:latest. The import will override existing dashboard configurations if present.

Parameters:
  • parsed_args (Optional[Namespace]) – Command line arguments produced by argparse.

  • zip_file (Optional[str]) – Zip archived dashboard config.

make_zip_config(parsed_args)[source]#

Make a zip-archived Apache Superset dashboard config, using specified arguments.

Parameters:

parsed_args (Namespace) – Command line arguments produced by argparse.

Return type:

Path