Implemented local restful flask service and provided cmdline client
Added only the "Daily" call so far, submitting for early review/feedback Called as example "./rest_client.py daily 3" This depends on listed as requirements. Flask==1.0.2 flask-jsonpify==1.5.0 (will do later) flask-restful==0.3.6 TODO: make loading optional, cleanly unload on close unit tests, take feedback, tidy output, add other Telegram functions, onwards local rest server is enabled/disabled from within config.json. E.g "localrest": { "enabled": true }, The server is enabled from within existing rpc manager and makes use of the existing superclass (RPC) Through making use of the existing hard work done in rpc.py It *should be easy to add the other Telegram calls into local_rpc_server.py The server is wrapped in a thread to be non-blocking The server and client accept serialised calls or not, used in daily to return json The client can be used from command line or in a python client script As example, from cmdline for last 3 days Daily DannyMBP:rpc creslin$ ./rest_client.py daily 3 [ [ "2018-06-13", "0.00000000 USDT", "0.000 USD", "0 trade" ], [ "2018-06-12", "0.00000000 USDT", "0.000 USD", "0 trade" ], [ "2018-06-11", "0.00000000 USDT", "0.000 USD", "0 trade" ] ]
This commit is contained in:
parent
efbeabf141
commit
e5e64a7035
@ -1,19 +1,19 @@
|
|||||||
import threading
|
import threading
|
||||||
import time
|
|
||||||
import zerorpc
|
|
||||||
import logging
|
import logging
|
||||||
import json
|
import json
|
||||||
|
|
||||||
|
from flask import Flask, request
|
||||||
|
from flask_restful import Resource, Api
|
||||||
|
from json import dumps
|
||||||
from freqtrade.rpc.rpc import RPC
|
from freqtrade.rpc.rpc import RPC
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
class LocalRPCControls(object):
|
|
||||||
"""
|
class Daily(Resource):
|
||||||
zeroRPC - allows local cmdline calls to super class in rpc.py
|
# called by http://127.0.0.1:/daily?timescale=7
|
||||||
as used by Telegram.py
|
# where 7 is the number of days to report back with.
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, freqtrade) -> None:
|
def __init__(self, freqtrade) -> None:
|
||||||
"""
|
"""
|
||||||
@ -24,18 +24,9 @@ class LocalRPCControls(object):
|
|||||||
self.freqtrade = freqtrade
|
self.freqtrade = freqtrade
|
||||||
self._config = freqtrade.config
|
self._config = freqtrade.config
|
||||||
|
|
||||||
# # Example of calling none serialed call
|
|
||||||
# # without decorator - left if as template while in dev for me
|
|
||||||
# def add_42(self, n):
|
|
||||||
# """ Add 42 to an integer argument to make it cooler, and return the
|
|
||||||
# result. """
|
|
||||||
# n = int(n)
|
|
||||||
# r = n + 42
|
|
||||||
# s = str(r)
|
|
||||||
# return s
|
|
||||||
|
|
||||||
@zerorpc.stream
|
def get(self):
|
||||||
def daily(self, timescale):
|
timescale = request.args.get('timescale')
|
||||||
logger.info("LocalRPC - Daily Command Called")
|
logger.info("LocalRPC - Daily Command Called")
|
||||||
timescale = int(timescale)
|
timescale = int(timescale)
|
||||||
|
|
||||||
@ -43,18 +34,21 @@ class LocalRPCControls(object):
|
|||||||
self._config['stake_currency'],
|
self._config['stake_currency'],
|
||||||
self._config['fiat_display_currency']
|
self._config['fiat_display_currency']
|
||||||
)
|
)
|
||||||
|
if error == False:
|
||||||
|
stats = dumps(stats, indent=4, sort_keys=True, default=str)
|
||||||
|
return stats
|
||||||
|
else:
|
||||||
|
json.dumps(error)
|
||||||
|
return error
|
||||||
|
|
||||||
#Everything in stats to a string, serialised, then back to client.
|
|
||||||
stats = json.dumps(stats, indent=4, sort_keys=True, default=str)
|
|
||||||
return(error, stats)
|
|
||||||
|
|
||||||
class LocalRPCSuperWrap(RPC):
|
class LocalRestSuperWrap(RPC):
|
||||||
"""
|
"""
|
||||||
Telegram, this class send messages to Telegram
|
This class is for REST cmd line client
|
||||||
"""
|
"""
|
||||||
def __init__(self, freqtrade) -> None:
|
def __init__(self, freqtrade) -> None:
|
||||||
"""
|
"""
|
||||||
Init the LocalRPCServer call, and init the super class RPC
|
Init the LocalRestServer call, and init the super class RPC
|
||||||
:param freqtrade: Instance of a freqtrade bot
|
:param freqtrade: Instance of a freqtrade bot
|
||||||
:return: None
|
:return: None
|
||||||
"""
|
"""
|
||||||
@ -73,11 +67,17 @@ class LocalRPCSuperWrap(RPC):
|
|||||||
""" Method that runs forever """
|
""" Method that runs forever """
|
||||||
self._config = freqtrade.config
|
self._config = freqtrade.config
|
||||||
|
|
||||||
|
|
||||||
# TODO add IP address / port to bind to in config.json and use in below.
|
# TODO add IP address / port to bind to in config.json and use in below.
|
||||||
while True:
|
logger.info('Starting Local Rest Server')
|
||||||
# Do something
|
|
||||||
logger.info('Starting Local RPC Listener')
|
my_freqtrade = freqtrade
|
||||||
s = zerorpc.Server(LocalRPCControls(freqtrade))
|
app = Flask(__name__)
|
||||||
s.bind("tcp://0.0.0.0:4242")
|
api = Api(app)
|
||||||
s.run()
|
|
||||||
time.sleep(self.interval)
|
# Our resources for restful apps go here, pass freqtrade object across
|
||||||
|
api.add_resource(Daily, '/daily', methods=['GET'],
|
||||||
|
resource_class_kwargs={'freqtrade': my_freqtrade}) # Route for returning daily
|
||||||
|
|
||||||
|
#run the server
|
||||||
|
app.run(port='5002')
|
23
freqtrade/rpc/rest_client.py
Executable file
23
freqtrade/rpc/rest_client.py
Executable file
@ -0,0 +1,23 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Simple command line client into RPC commands
|
||||||
|
Can be used as an alternate to Telegram
|
||||||
|
"""
|
||||||
|
|
||||||
|
from requests import get
|
||||||
|
from sys import argv
|
||||||
|
|
||||||
|
if len(argv) == 1:
|
||||||
|
print('\nThis script accepts the following arguments')
|
||||||
|
print('- daily (int) - Where int is the number of days to report back. daily 3')
|
||||||
|
print('- there will be more....\n')
|
||||||
|
|
||||||
|
if len(argv) == 3 and argv[1] == "daily":
|
||||||
|
if str.isnumeric(argv[2]):
|
||||||
|
get_url = 'http://localhost:5002/daily?timescale=' + argv[2]
|
||||||
|
d=get(get_url).json()
|
||||||
|
print(d)
|
||||||
|
else:
|
||||||
|
print("\nThe second argument to daily must be an integer, 1,2,3 etc")
|
||||||
|
|
||||||
|
|
@ -6,7 +6,7 @@ import logging
|
|||||||
import time
|
import time
|
||||||
|
|
||||||
from freqtrade.rpc.telegram import Telegram
|
from freqtrade.rpc.telegram import Telegram
|
||||||
from freqtrade.rpc.local_rpc_server import LocalRPCSuperWrap
|
from freqtrade.rpc.local_rest_server import LocalRestSuperWrap
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
@ -40,8 +40,8 @@ class RPCManager(object):
|
|||||||
|
|
||||||
# Added another RPC client - for cmdline local client.
|
# Added another RPC client - for cmdline local client.
|
||||||
# Uses existing superclass RPC build for Telegram
|
# Uses existing superclass RPC build for Telegram
|
||||||
if self.freqtrade.config['localrpc'].get('enabled', False):
|
if self.freqtrade.config['rest_cmd'].get('enabled', False):
|
||||||
self.localRPC = LocalRPCSuperWrap(self.freqtrade)
|
self.localRPC = LocalRestSuperWrap(self.freqtrade)
|
||||||
time.sleep(1)
|
time.sleep(1)
|
||||||
|
|
||||||
def cleanup(self) -> None:
|
def cleanup(self) -> None:
|
||||||
|
@ -24,5 +24,7 @@ coinmarketcap==5.0.3
|
|||||||
# Required for plotting data
|
# Required for plotting data
|
||||||
#plotly==2.3.0
|
#plotly==2.3.0
|
||||||
|
|
||||||
#Added for localRCP
|
#Added for local rest client
|
||||||
zerorpc==
|
Flask==1.0.2
|
||||||
|
flask-jsonpify==1.5.0
|
||||||
|
flask-restful==0.3.6
|
||||||
|
Loading…
Reference in New Issue
Block a user