Merge pull request #2831 from xmatthias/feat/new_config

introduce new-config subcommand

freqtrade/commands/__init__.py

@@ -7,6 +7,7 @@ Note: Be careful with file-scoped imports in these subfiles.
     as they are parsed on startup, nothing containing optional modules should be loaded.
 """
 from freqtrade.commands.arguments import Arguments
+from freqtrade.commands.build_config_commands import start_new_config
 from freqtrade.commands.data_commands import start_download_data
 from freqtrade.commands.deploy_commands import (start_create_userdir,
                                                 start_new_hyperopt,

freqtrade/commands/arguments.py

@@ -45,6 +45,8 @@ ARGS_TEST_PAIRLIST = ["config", "quote_currencies", "print_one_column", "list_pa
 
 ARGS_CREATE_USERDIR = ["user_data_dir", "reset"]
 
+ARGS_BUILD_CONFIG = ["config"]
+
 ARGS_BUILD_STRATEGY = ["user_data_dir", "strategy", "template"]
 
 ARGS_BUILD_HYPEROPT = ["user_data_dir", "hyperopt", "template"]
@@ -136,7 +138,7 @@ class Arguments:
                                         start_hyperopt_list, start_hyperopt_show,
                                         start_list_exchanges, start_list_hyperopts,
                                         start_list_markets, start_list_strategies,
-                                        start_list_timeframes,
+                                        start_list_timeframes, start_new_config,
                                         start_new_hyperopt, start_new_strategy,
                                         start_plot_dataframe, start_plot_profit,
                                         start_backtesting, start_hyperopt, start_edge,
@@ -180,6 +182,12 @@ class Arguments:
         create_userdir_cmd.set_defaults(func=start_create_userdir)
         self._build_args(optionlist=ARGS_CREATE_USERDIR, parser=create_userdir_cmd)
 
+        # add new-config subcommand
+        build_config_cmd = subparsers.add_parser('new-config',
+                                                 help="Create new config")
+        build_config_cmd.set_defaults(func=start_new_config)
+        self._build_args(optionlist=ARGS_BUILD_CONFIG, parser=build_config_cmd)
+
         # add new-strategy subcommand
         build_strategy_cmd = subparsers.add_parser('new-strategy',
                                                    help="Create new strategy")

freqtrade/commands/build_config_commands.py

@@ -0,0 +1,193 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict
+
+from questionary import Separator, prompt
+
+from freqtrade.constants import UNLIMITED_STAKE_AMOUNT
+from freqtrade.exchange import available_exchanges, MAP_EXCHANGE_CHILDCLASS
+from freqtrade.misc import render_template
+from freqtrade.exceptions import OperationalException
+logger = logging.getLogger(__name__)
+
+
+def validate_is_int(val):
+    try:
+        _ = int(val)
+        return True
+    except Exception:
+        return False
+
+
+def validate_is_float(val):
+    try:
+        _ = float(val)
+        return True
+    except Exception:
+        return False
+
+
+def ask_user_overwrite(config_path: Path) -> bool:
+    questions = [
+        {
+            "type": "confirm",
+            "name": "overwrite",
+            "message": f"File {config_path} already exists. Overwrite?",
+            "default": False,
+        },
+    ]
+    answers = prompt(questions)
+    return answers['overwrite']
+
+
+def ask_user_config() -> Dict[str, Any]:
+    """
+    Ask user a few questions to build the configuration.
+    Interactive questions built using https://github.com/tmbo/questionary
+    :returns: Dict with keys to put into template
+    """
+    questions = [
+        {
+            "type": "confirm",
+            "name": "dry_run",
+            "message": "Do you want to enable Dry-run (simulated trades)?",
+            "default": True,
+        },
+        {
+            "type": "text",
+            "name": "stake_currency",
+            "message": "Please insert your stake currency:",
+            "default": 'BTC',
+        },
+        {
+            "type": "text",
+            "name": "stake_amount",
+            "message": "Please insert your stake amount:",
+            "default": "0.01",
+            "validate": lambda val: val == UNLIMITED_STAKE_AMOUNT or validate_is_float(val),
+        },
+        {
+            "type": "text",
+            "name": "max_open_trades",
+            "message": f"Please insert max_open_trades (Integer or '{UNLIMITED_STAKE_AMOUNT}'):",
+            "default": "3",
+            "validate": lambda val: val == UNLIMITED_STAKE_AMOUNT or validate_is_int(val)
+        },
+        {
+            "type": "text",
+            "name": "ticker_interval",
+            "message": "Please insert your ticker interval:",
+            "default": "5m",
+        },
+        {
+            "type": "text",
+            "name": "fiat_display_currency",
+            "message": "Please insert your display Currency (for reporting):",
+            "default": 'USD',
+        },
+        {
+            "type": "select",
+            "name": "exchange_name",
+            "message": "Select exchange",
+            "choices": [
+                "binance",
+                "binanceje",
+                "binanceus",
+                "bittrex",
+                "kraken",
+                Separator(),
+                "other",
+            ],
+        },
+        {
+            "type": "autocomplete",
+            "name": "exchange_name",
+            "message": "Type your exchange name (Must be supported by ccxt)",
+            "choices": available_exchanges(),
+            "when": lambda x: x["exchange_name"] == 'other'
+        },
+        {
+            "type": "password",
+            "name": "exchange_key",
+            "message": "Insert Exchange Key",
+            "when": lambda x: not x['dry_run']
+        },
+        {
+            "type": "password",
+            "name": "exchange_secret",
+            "message": "Insert Exchange Secret",
+            "when": lambda x: not x['dry_run']
+        },
+        {
+            "type": "confirm",
+            "name": "telegram",
+            "message": "Do you want to enable Telegram?",
+            "default": False,
+        },
+        {
+            "type": "password",
+            "name": "telegram_token",
+            "message": "Insert Telegram token",
+            "when": lambda x: x['telegram']
+        },
+        {
+            "type": "text",
+            "name": "telegram_chat_id",
+            "message": "Insert Telegram chat id",
+            "when": lambda x: x['telegram']
+        },
+    ]
+    answers = prompt(questions)
+
+    if not answers:
+        # Interrupted questionary sessions return an empty dict.
+        raise OperationalException("User interrupted interactive questions.")
+
+    return answers
+
+
+def deploy_new_config(config_path: Path, selections: Dict[str, Any]) -> None:
+    """
+    Applies selections to the template and writes the result to config_path
+    :param config_path: Path object for new config file. Should not exist yet
+    :param selecions: Dict containing selections taken by the user.
+    """
+    from jinja2.exceptions import TemplateNotFound
+    try:
+        exchange_template = MAP_EXCHANGE_CHILDCLASS.get(
+            selections['exchange_name'], selections['exchange_name'])
+
+        selections['exchange'] = render_template(
+            templatefile=f"subtemplates/exchange_{exchange_template}.j2",
+            arguments=selections
+            )
+    except TemplateNotFound:
+        selections['exchange'] = render_template(
+            templatefile=f"subtemplates/exchange_generic.j2",
+            arguments=selections
+        )
+
+    config_text = render_template(templatefile='base_config.json.j2',
+                                  arguments=selections)
+
+    logger.info(f"Writing config to `{config_path}`.")
+    config_path.write_text(config_text)
+
+
+def start_new_config(args: Dict[str, Any]) -> None:
+    """
+    Create a new strategy from a template
+    Asking the user questions to fill out the templateaccordingly.
+    """
+
+    config_path = Path(args['config'][0])
+    if config_path.exists():
+        overwrite = ask_user_overwrite(config_path)
+        if overwrite:
+            config_path.unlink()
+        else:
+            raise OperationalException(
+                f"Configuration file `{config_path}` already exists. "
+                "Please delete it or use a different configuration file name.")
+    selections = ask_user_config()
+    deploy_new_config(config_path, selections)