Source code for gfinder.commands.scenarios

"""GFINDER CLI `scenarios` command."""

import click
from .docstring import set_docstring

from gfinder.config import Config
from gfinder.datastore import DataStore


@click.command(name='scenarios')
@click.option('--mission-scenario-id', type=click.STRING, help='Mission scenario ID (default: '+Config().default_mission_scenario_id+')')
def scenarios_cmd(mission_scenario_id):
    """List available mission scenarios.
    """
    scenarios(mission_scenario_id=mission_scenario_id)


@set_docstring(scenarios_cmd)
def scenarios(mission_scenario_id=None):

    click.echo()
    click.echo('Available mission scenarios:')
    click.echo(DataStore().getMissionScenarioIDs())
    click.echo()