Merge pull request #5275 from samgermain/example_json_filename_extensions

Example json filename extensions

.github/workflows/ci.yml

@@ -79,13 +79,13 @@ jobs:
 
     - name: Backtesting
       run: |
-        cp config_bittrex.json.example config.json
+        cp config_examples/config_bittrex.example.json config.json
         freqtrade create-userdir --userdir user_data
         freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
 
     - name: Hyperopt
       run: |
-        cp config_bittrex.json.example config.json
+        cp config_examples/config_bittrex.example.json config.json
         freqtrade create-userdir --userdir user_data
         freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily --print-all
 
@@ -172,13 +172,13 @@ jobs:
 
     - name: Backtesting
       run: |
-        cp config_bittrex.json.example config.json
+        cp config_examples/config_bittrex.example.json config.json
         freqtrade create-userdir --userdir user_data
         freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
 
     - name: Hyperopt
       run: |
-        cp config_bittrex.json.example config.json
+        cp config_examples/config_bittrex.example.json config.json
         freqtrade create-userdir --userdir user_data
         freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily --print-all
 
@@ -239,13 +239,13 @@ jobs:
 
     - name: Backtesting
       run: |
-        cp config_bittrex.json.example config.json
+        cp config_examples/config_bittrex.example.json config.json
         freqtrade create-userdir --userdir user_data
         freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
 
     - name: Hyperopt
       run: |
-        cp config_bittrex.json.example config.json
+        cp config_examples/config_bittrex.example.json config.json
         freqtrade create-userdir --userdir user_data
         freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily --print-all
 

.gitignore

@@ -95,3 +95,8 @@ target/
 
 #exceptions
 !*.gitkeep
+!config_examples/config_binance.example.json
+!config_examples/config_bittrex.example.json
+!config_examples/config_ftx.example.json
+!config_examples/config_full.example.json
+!config_examples/config_kraken.example.json

.travis.yml

@@ -26,12 +26,12 @@ jobs:
       # - coveralls || true
       name: pytest
     - script:
-      - cp config_bittrex.json.example config.json
+      - cp config_examples/config_bittrex.example.json config.json
       - freqtrade create-userdir --userdir user_data
       - freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
       name: backtest
     - script:
-      - cp config_bittrex.json.example config.json
+      - cp config_examples/config_bittrex.example.json config.json
       - freqtrade create-userdir --userdir user_data
       - freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt SampleHyperOpt --hyperopt-loss SharpeHyperOptLossDaily
       name: hyperopt

build_helpers/publish_docker_multi.sh

@@ -52,7 +52,7 @@ docker build --cache-from freqtrade:${TAG} --build-arg sourceimage=${TAG} -t fre
 docker tag freqtrade:$TAG_PLOT ${IMAGE_NAME}:$TAG_PLOT
 
 # Run backtest
-docker run --rm -v $(pwd)/config_bittrex.json.example:/freqtrade/config.json:ro -v $(pwd)/tests:/tests freqtrade:${TAG} backtesting --datadir /tests/testdata --strategy-path /tests/strategy/strats/ --strategy DefaultStrategy
+docker run --rm -v $(pwd)/config_examples/config_bittrex.example.json:/freqtrade/config.json:ro -v $(pwd)/tests:/tests freqtrade:${TAG} backtesting --datadir /tests/testdata --strategy-path /tests/strategy/strats/ --strategy DefaultStrategy
 
 if [ $? -ne 0 ]; then
     echo "failed running backtest"

docs/configuration.md

@@ -573,7 +573,7 @@ You should also make sure to read the [Exchanges](exchanges.md) section of the d
 
 To use a proxy with freqtrade, add the kwarg `"aiohttp_trust_env"=true` to the `"ccxt_async_kwargs"` dict in the exchange section of the configuration.
 
-An example for this can be found in `config_full.json.example`
+An example for this can be found in `config_examples/config_full.example.json`
 
 ``` json
 "ccxt_async_config": {

tests/commands/test_commands.py

@@ -26,7 +26,7 @@ from tests.conftest_trades import MOCK_TRADE_COUNT
 
 def test_setup_utils_configuration():
     args = [
-        'list-exchanges', '--config', 'config_bittrex.json.example',
+        'list-exchanges', '--config', 'config_examples/config_bittrex.example.json',
     ]
 
     config = setup_utils_configuration(get_args(args), RunMode.OTHER)
@@ -45,7 +45,7 @@ def test_start_trading_fail(mocker, caplog):
     exitmock = mocker.patch("freqtrade.worker.Worker.exit", MagicMock())
     args = [
         'trade',
-        '-c', 'config_bittrex.json.example'
+        '-c', 'config_examples/config_bittrex.example.json'
     ]
     start_trading(get_args(args))
     assert exitmock.call_count == 1
@@ -127,10 +127,10 @@ def test_list_timeframes(mocker, capsys):
                        match=r"This command requires a configured exchange.*"):
         start_list_timeframes(pargs)
 
-    # Test with --config config_bittrex.json.example
+    # Test with --config config_examples/config_bittrex.example.json
     args = [
         "list-timeframes",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
     ]
     start_list_timeframes(get_args(args))
     captured = capsys.readouterr()
@@ -174,7 +174,7 @@ def test_list_timeframes(mocker, capsys):
     # Test with --one-column
     args = [
         "list-timeframes",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--one-column",
     ]
     start_list_timeframes(get_args(args))
@@ -214,10 +214,10 @@ def test_list_markets(mocker, markets, capsys):
                        match=r"This command requires a configured exchange.*"):
         start_list_markets(pargs, False)
 
-    # Test with --config config_bittrex.json.example
+    # Test with --config config_examples/config_bittrex.example.json
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--print-list",
     ]
     start_list_markets(get_args(args), False)
@@ -244,7 +244,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test with --all: all markets
     args = [
         "list-markets", "--all",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--print-list",
     ]
     start_list_markets(get_args(args), False)
@@ -257,7 +257,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test list-pairs subcommand: active pairs
     args = [
         "list-pairs",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--print-list",
     ]
     start_list_markets(get_args(args), True)
@@ -269,7 +269,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test list-pairs subcommand with --all: all pairs
     args = [
         "list-pairs", "--all",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--print-list",
     ]
     start_list_markets(get_args(args), True)
@@ -282,7 +282,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, base=ETH, LTC
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "ETH", "LTC",
         "--print-list",
     ]
@@ -295,7 +295,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, base=LTC
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "LTC",
         "--print-list",
     ]
@@ -308,7 +308,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, quote=USDT, USD
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--quote", "USDT", "USD",
         "--print-list",
     ]
@@ -321,7 +321,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, quote=USDT
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--quote", "USDT",
         "--print-list",
     ]
@@ -334,7 +334,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, base=LTC, quote=USDT
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "LTC", "--quote", "USDT",
         "--print-list",
     ]
@@ -347,7 +347,7 @@ def test_list_markets(mocker, markets, capsys):
     # active pairs, base=LTC, quote=USDT
     args = [
         "list-pairs",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "LTC", "--quote", "USD",
         "--print-list",
     ]
@@ -360,7 +360,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, base=LTC, quote=USDT, NONEXISTENT
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "LTC", "--quote", "USDT", "NONEXISTENT",
         "--print-list",
     ]
@@ -373,7 +373,7 @@ def test_list_markets(mocker, markets, capsys):
     # active markets, base=LTC, quote=NONEXISTENT
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "LTC", "--quote", "NONEXISTENT",
         "--print-list",
     ]
@@ -386,7 +386,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test tabular output
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
     ]
     start_list_markets(get_args(args), False)
     captured = capsys.readouterr()
@@ -396,7 +396,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test tabular output, no markets found
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--base", "LTC", "--quote", "NONEXISTENT",
     ]
     start_list_markets(get_args(args), False)
@@ -408,7 +408,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test --print-json
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--print-json"
     ]
     start_list_markets(get_args(args), False)
@@ -420,7 +420,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test --print-csv
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--print-csv"
     ]
     start_list_markets(get_args(args), False)
@@ -432,7 +432,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test --one-column
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--one-column"
     ]
     start_list_markets(get_args(args), False)
@@ -444,7 +444,7 @@ def test_list_markets(mocker, markets, capsys):
     # Test --one-column
     args = [
         "list-markets",
-        '--config', 'config_bittrex.json.example',
+        '--config', 'config_examples/config_bittrex.example.json',
         "--one-column"
     ]
     with pytest.raises(OperationalException, match=r"Cannot get markets.*"):
@@ -887,7 +887,7 @@ def test_start_test_pairlist(mocker, caplog, tickers, default_conf, capsys):
     patched_configuration_load_config_file(mocker, default_conf)
     args = [
         'test-pairlist',
-        '-c', 'config_bittrex.json.example'
+        '-c', 'config_examples/config_bittrex.example.json'
     ]
 
     start_test_pairlist(get_args(args))
@@ -901,7 +901,7 @@ def test_start_test_pairlist(mocker, caplog, tickers, default_conf, capsys):
 
     args = [
         'test-pairlist',
-        '-c', 'config_bittrex.json.example',
+        '-c', 'config_examples/config_bittrex.example.json',
         '--one-column',
     ]
     start_test_pairlist(get_args(args))
@@ -910,7 +910,7 @@ def test_start_test_pairlist(mocker, caplog, tickers, default_conf, capsys):
 
     args = [
         'test-pairlist',
-        '-c', 'config_bittrex.json.example',
+        '-c', 'config_examples/config_bittrex.example.json',
         '--print-json',
     ]
     start_test_pairlist(get_args(args))

tests/test_arguments.py

@@ -172,7 +172,7 @@ def test_download_data_options() -> None:
 def test_plot_dataframe_options() -> None:
     args = [
         'plot-dataframe',
-        '-c', 'config_bittrex.json.example',
+        '-c', 'config_examples/config_bittrex.example.json',
         '--indicators1', 'sma10', 'sma100',
         '--indicators2', 'macd', 'fastd', 'fastk',
         '--plot-limit', '30',

tests/test_configuration.py

@@ -28,7 +28,7 @@ from tests.conftest import log_has, log_has_re, patched_configuration_load_confi
 
 @pytest.fixture(scope="function")
 def all_conf():
-    config_file = Path(__file__).parents[1] / "config_full.json.example"
+    config_file = Path(__file__).parents[1] / "config_examples/config_full.example.json"
     conf = load_config_file(str(config_file))
     return conf
 

tests/test_main.py

@@ -67,12 +67,12 @@ def test_main_fatal_exception(mocker, default_conf, caplog) -> None:
     mocker.patch('freqtrade.freqtradebot.RPCManager', MagicMock())
     mocker.patch('freqtrade.freqtradebot.init_db', MagicMock())
 
-    args = ['trade', '-c', 'config_bittrex.json.example']
+    args = ['trade', '-c', 'config_examples/config_bittrex.example.json']
 
     # Test Main + the KeyboardInterrupt exception
     with pytest.raises(SystemExit):
         main(args)
-    assert log_has('Using config: config_bittrex.json.example ...', caplog)
+    assert log_has('Using config: config_examples/config_bittrex.example.json ...', caplog)
     assert log_has('Fatal exception!', caplog)
 
 
@@ -85,12 +85,12 @@ def test_main_keyboard_interrupt(mocker, default_conf, caplog) -> None:
     mocker.patch('freqtrade.wallets.Wallets.update', MagicMock())
     mocker.patch('freqtrade.freqtradebot.init_db', MagicMock())
 
-    args = ['trade', '-c', 'config_bittrex.json.example']
+    args = ['trade', '-c', 'config_examples/config_bittrex.example.json']
 
     # Test Main + the KeyboardInterrupt exception
     with pytest.raises(SystemExit):
         main(args)
-    assert log_has('Using config: config_bittrex.json.example ...', caplog)
+    assert log_has('Using config: config_examples/config_bittrex.example.json ...', caplog)
     assert log_has('SIGINT received, aborting ...', caplog)
 
 
@@ -106,12 +106,12 @@ def test_main_operational_exception(mocker, default_conf, caplog) -> None:
     mocker.patch('freqtrade.freqtradebot.RPCManager', MagicMock())
     mocker.patch('freqtrade.freqtradebot.init_db', MagicMock())
 
-    args = ['trade', '-c', 'config_bittrex.json.example']
+    args = ['trade', '-c', 'config_examples/config_bittrex.example.json']
 
     # Test Main + the KeyboardInterrupt exception
     with pytest.raises(SystemExit):
         main(args)
-    assert log_has('Using config: config_bittrex.json.example ...', caplog)
+    assert log_has('Using config: config_examples/config_bittrex.example.json ...', caplog)
     assert log_has('Oh snap!', caplog)
 
 
@@ -157,12 +157,16 @@ def test_main_reload_config(mocker, default_conf, caplog) -> None:
     mocker.patch('freqtrade.freqtradebot.RPCManager', MagicMock())
     mocker.patch('freqtrade.freqtradebot.init_db', MagicMock())
 
-    args = Arguments(['trade', '-c', 'config_bittrex.json.example']).get_parsed_arg()
+    args = Arguments([
+        'trade',
+        '-c',
+        'config_examples/config_bittrex.example.json'
+    ]).get_parsed_arg()
     worker = Worker(args=args, config=default_conf)
     with pytest.raises(SystemExit):
-        main(['trade', '-c', 'config_bittrex.json.example'])
+        main(['trade', '-c', 'config_examples/config_bittrex.example.json'])
 
-    assert log_has('Using config: config_bittrex.json.example ...', caplog)
+    assert log_has('Using config: config_examples/config_bittrex.example.json ...', caplog)
     assert worker_mock.call_count == 4
     assert reconfigure_mock.call_count == 1
     assert isinstance(worker.freqtrade, FreqtradeBot)
@@ -180,7 +184,11 @@ def test_reconfigure(mocker, default_conf) -> None:
     mocker.patch('freqtrade.freqtradebot.RPCManager', MagicMock())
     mocker.patch('freqtrade.freqtradebot.init_db', MagicMock())
 
-    args = Arguments(['trade', '-c', 'config_bittrex.json.example']).get_parsed_arg()
+    args = Arguments([
+        'trade',
+        '-c',
+        'config_examples/config_bittrex.example.json'
+    ]).get_parsed_arg()
     worker = Worker(args=args, config=default_conf)
     freqtrade = worker.freqtrade
 

tests/test_plotting.py

@@ -364,7 +364,7 @@ def test_start_plot_dataframe(mocker):
     aup = mocker.patch("freqtrade.plot.plotting.load_and_plot_trades", MagicMock())
     args = [
         "plot-dataframe",
-        "--config", "config_bittrex.json.example",
+        "--config", "config_examples/config_bittrex.example.json",
         "--pairs", "ETH/BTC"
     ]
     start_plot_dataframe(get_args(args))
@@ -408,7 +408,7 @@ def test_start_plot_profit(mocker):
     aup = mocker.patch("freqtrade.plot.plotting.plot_profit", MagicMock())
     args = [
         "plot-profit",
-        "--config", "config_bittrex.json.example",
+        "--config", "config_examples/config_bittrex.example.json",
         "--pairs", "ETH/BTC"
     ]
     start_plot_profit(get_args(args))