Merge pull request #65 from robswc/async-actions

feat: add beta support for async webhooks.

Author: robswc

README.md

@@ -27,6 +27,12 @@ TVWB uses [Flask](https://flask.palletsprojects.com/en/2.2.x/) to handle the web
 
 # Quickstart 📘
 
+### Docker compose command
+
+```bash
+docker-compose run app start
+```
+
 ### Installation
 
 * [Docker](https://github.com/robswc/tradingview-webhooks-bot/wiki/Docker) (recommended)

docker-compose.yml

@@ -8,5 +8,4 @@ services:
             - ./src/settings.py:/app/settings.py
         ports:
             - "5000:5000"
-        network_mode: 'host'
         entrypoint: python3 tvwb.py

src/components/actions/async_demo.py

@@ -0,0 +1,19 @@
+from time import sleep
+
+from components.actions.base.action import Action
+
+
+class AsyncDemo(Action):
+    def __init__(self):
+        super().__init__()
+
+    def run(self, *args, **kwargs):
+        super().run(*args, **kwargs)  # this is required
+        """
+        Custom run method. Add your custom logic here.
+        """
+        print(self.name, '---> action has started...')
+        for i in range(5):
+            print(f'{self.name} ---> {i}')
+            sleep(1)
+        print(self.name, '---> action has completed!')

src/main.py

@@ -59,7 +59,7 @@ def dashboard():
 
 
 @app.route("/webhook", methods=["POST"])
-def webhook():
+async def webhook():
     if request.method == 'POST':
         data = request.get_json()
         if data is None:

src/requirements.txt

@@ -1,14 +1,15 @@
+asgiref==3.7.2
 blinker==1.6.2
 click==8.1.3
 colorama==0.4.6
-Flask==2.3.2
+Flask[async]==3.0.2
 gunicorn==20.1.0
 importlib-metadata==6.6.0
 itsdangerous==2.1.2
 Jinja2==3.1.2
 MarkupSafe==2.1.2
-shellingham==1.5.1
-typer==0.9.0
+shellingham==1.4.0
+typer==0.7.0
 typer-cli==0.0.13
 typing_extensions==4.5.0
 Werkzeug==2.3.3

src/settings.py

@@ -1,9 +1,9 @@
 # actions
-REGISTERED_ACTIONS = ['PrintData']
+REGISTERED_ACTIONS = ['PrintData', 'AsyncDemo']
 
 # events
 REGISTERED_EVENTS = ['WebhookReceived']
 
 # links
-REGISTERED_LINKS = [('PrintData', 'WebhookReceived')]
+REGISTERED_LINKS = [('PrintData', 'WebhookReceived'), ('AsyncDemo', 'WebhookReceived')]
 

src/tvwb.py

@@ -1,3 +1,4 @@
+import json
 import os
 from subprocess import run
 
@@ -196,16 +197,19 @@ def trigger_event(name: str):
     logger.info(f'Triggering event --->\t{name}')
     # import event
     event = getattr(__import__(f'components.events.{snake_case(name)}', fromlist=['']), name)()
-    event.trigger_actions()
+    event.trigger({})
     return True
 
 
-@app.command('shell')
-def shell():
-    cmd = '--help'
-    while cmd not in ['exit', 'quit', 'q']:
-        run(f'python3 tvwb.py {cmd}'.split(' '))
-        cmd = typer.prompt("Enter TVWB command (q) to exit")
+@app.command('util:send-webhook')
+def send_webhook(key: str):
+    logger.info(f'Sending webhook')
+    post_data = json.dumps({
+        "test": "data",
+        "key": key})
+    # send with curl
+    run(['curl', '-X', 'POST', '-H', 'Content-Type: application/json', '-d', post_data,
+         'http://localhost:5000/webhook'])
 
 
 if __name__ == "__main__":