TradingView-Webhook-Bot/README.md

60 wiersze
4.4 KiB
Markdown
Czysty Zwykły widok Historia

2020-08-21 07:29:28 +00:00
<p align="center"><a href="https://github.com/TheDevFab/TradingView-Webhook-Bot" target="_blank"><img src="https://i.imgur.com/ubEoI7w.png"></a></p>
2020-04-21 14:29:54 +00:00
2020-07-04 07:38:38 +00:00
<p align="center">
<a href="https://www.python.org/downloads/release/python-380/"><img src="https://img.shields.io/badge/python-3.8-blue.svg?style=plastic" alt="Python version"></a>
2020-08-21 07:29:28 +00:00
<a href="https://github.com/TheDevFab/TradingView-Webhook-Bot/blob/master/LICENSE"><img src="https://img.shields.io/github/license/TheDevFab/TradingView-Webhook-Bot?style=plastic" alt="GitHub license"></a>
<a href="https://github.com/TheDevFab/TradingView-Webhook-Bot/issues"><img src="https://img.shields.io/github/issues/TheDevFab/TradingView-Webhook-Bot?style=plastic" alt="GitHub issues"></a>
<a href="https://github.com/TheDevFab/TradingView-Webhook-Bot/pulls"><img src="https://img.shields.io/github/issues-pr/TheDevFab/TradingView-Webhook-Bot?style=plastic" alt="GitHub pull requests"></a>
<br /><a href="https://github.com/TheDevFab/TradingView-Webhook-Bot/stargazers"><img src="https://img.shields.io/github/stars/TheDevFab/TradingView-Webhook-Bot?style=social" alt="GitHub stars"></a>
<a href="https://github.com/TheDevFab/TradingView-Webhook-Bot/network/members"><img src="https://img.shields.io/github/forks/TheDevFab/TradingView-Webhook-Bot?style=social" alt="GitHub forks"></a>
<a href="https://github.com/TheDevFab/TradingView-Webhook-Bot/watchers"><img src="https://img.shields.io/github/watchers/TheDevFab/TradingView-Webhook-Bot?style=social" alt="GitHub watchers"></a>
2020-07-04 07:38:38 +00:00
</p>
2020-04-21 14:29:54 +00:00
2020-07-04 07:38:38 +00:00
<p align="center">
<a href="#about">About</a>
<a href="#features">Features</a>
<a href="#installation">Installation</a>
<a href="#images">Images</a>
<a href="#how-can-i-help">Help</a>
</p>
2020-04-21 14:29:54 +00:00
2020-07-04 07:38:38 +00:00
## About
The **TradingView Webhook Bot** ⚙️ listens to [TradingView](https://tradingview.com) alerts via [webhooks](https://www.tradingview.com/support/solutions/43000529348-i-want-to-know-more-about-webhooks/) using [flask](https://flask.palletsprojects.com/en/1.1.x/).
All alerts can be instantly sent to Telegram, Discord, Twitter and/or Email.
2020-07-04 07:38:38 +00:00
## Features
- Telegram Support using the [Python Telegram](https://github.com/python-telegram-bot/python-telegram-bot) libary
- Discord Support using [webhooks](https://support.discord.com/hc/de/articles/228383668-Webhooks-verwenden)
2020-07-11 08:08:51 +00:00
- Twitter Support using the [tweepy](https://github.com/tweepy/tweepy) libary
2020-07-04 07:38:38 +00:00
- Email Support using [smtplib](https://docs.python.org/3/library/smtplib.html)
2020-08-21 07:29:28 +00:00
- Alert channels can be enabled or disabled in [`config.py`](https://github.com/TheDevFab/TradingView-Webhook-Bot/blob/master/config.py)
- Whitelisted words can be easily added in [`config.py`](https://github.com/TheDevFab/TradingView-Webhook-Bot/blob/master/config.py)
2020-07-04 07:38:38 +00:00
- TradingView `{{close}}`, `{{exchange}}` etc. variables support. Read more [here](https://www.tradingview.com/blog/en/introducing-variables-in-alerts-14880/)
2020-08-21 07:29:28 +00:00
> 💡 Got a feature idea? Open an [issue](https://github.com/TheDevFab/TradingView-Webhook-Bot/issues/new) and I might implement it.
2020-07-11 08:08:51 +00:00
2020-07-04 07:38:38 +00:00
## Installation
2020-10-19 12:02:25 +00:00
> ⚠️ Best to run the bot on a VPS. I can recommend [Hetzner](https://hetzner.cloud/?ref=tQ1NdT8zbfNY).
2020-08-21 07:29:28 +00:00
1. Clone this repository `git clone https://github.com/TheDevFab/TradingView-Webhook-Bot.git`
2020-07-11 08:08:51 +00:00
1. Create your virtual environment `python3 -m venv TradingView-Webhook-Bot`
1. Activate it `source TradingView-Webhook-Bot/bin/activate && TradingView-Webhook-Bot`
1. Install all requirements `pip install -r requirements.txt`
2020-08-21 07:29:28 +00:00
1. Edit and update [`config.py`](https://github.com/TheDevFab/TradingView-Webhook-Bot/blob/master/config.py)
2020-07-11 08:08:51 +00:00
1. Setup TradingView alerts as shown [here](https://i.imgur.com/71UYTcu.png)
2020-04-21 17:43:52 +00:00
- TradingViews variables like `{{close}}`, `{{exchange}}` etc. work as well. More can be found [here](https://www.tradingview.com/blog/en/introducing-variables-in-alerts-14880/)
2020-07-16 07:09:36 +00:00
- Your webhook url would be `http://<YOUR-IP>/webhook`
1. If you use a firewall be sure to open port the corresponding port
2020-07-11 08:08:51 +00:00
1. Run the bot `python main.py`
2020-04-21 14:29:54 +00:00
*It is recommended to run flask on a different port like 8080. It is then necessary to forward port 80 to 8080.*
2020-04-21 17:43:52 +00:00
## Images
2020-07-04 07:38:38 +00:00
![Webhook Bot](https://i.imgur.com/vZA42cc.png)
2020-07-04 07:38:38 +00:00
## How can I help?
2020-07-11 08:08:51 +00:00
All kinds of contributions are welcome!
2020-10-19 12:02:25 +00:00
The most basic way to show your support is to `⭐️ star` the project, or to raise [`🐞issues`](https://github.com/TheDevFab/TradingView-Webhook-Bot/issues/new).