Skip to content

Commit

Permalink
remove donation links and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
titulebolide committed Jul 25, 2022
1 parent 0dd19e9 commit 76ac997
Show file tree
Hide file tree
Showing 11 changed files with 39 additions and 37 deletions.
66 changes: 39 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,61 @@
# Binance Trade Bot Manager Telegram

A Telegram bot for remotely managing Edendg23's [Binance Trade Bot](https://github.com/edeng23/binance-trade-bot) and its forks.
A Telegram bot for remotely managing Edendg23's [Binance Trade Bot](https://github.com/edeng23/binance-trade-bot) and its forks ([Idkravitz's](https://github.com/idkravitz/binance-trade-bot), [Tntwist's](https://github.com/tntwist/binance-trade-bot), [MasaiasuOse's](https://github.com/MasaiasuOse/binance-trade-bot) being the major forks).

This program aims to be an easy way of managing Binance Trade Bot] so that I wouldn't have to constantly ssh into my VPS, and my non-techy friends could enjoy the benefits of automated trading.
This program aims to be an easy way of managing Binance Trade Bot so that I wouldn't have to constantly ssh into my VPS, and my non-techy friends could enjoy the benefits of automated trading.

The program's default behavior fetches Telegram `token` and `chat_id` from [Binance Trade Bot]'s `apprise.yml` file. For a quick Telegram bot setup guide [click here](./docs/telegram-setup.md).
This program supports only Linux and WSL. Other distributions (BSD, MacOS, Windows, ...) are unmainted and support is not currently planned and is supposed to run 24/7. If you can't have a long running computer on linux, you can use a free VPS, such as Oracle Cloud's.

## Installation
### Docker install
For a Docker setup guide [click here](./docs/docker-setup.md).

### Manual install
## Manual install
**Python 3.7, 3.8 or 3.9** is required.
**BTB-manager-telegram** should be installed in the same parent directory as **Binance Trade Bot**. Your filesystem should look like this:

### 0 - Create a dedicated folder
Create a dedicated directory for the binance trade bot and the present manager. In this tutorial, we will be using **as an example** the folder `~/trading-bot`:
```bash
cd ~
mkdir trading-bot
```
PARENT_DIR
├── BTB-manager-telegram
└── binance-trade-bot

### 1 - Install binance trade bot.
Choose the fork you want to use. The main one ([Edendg23's](https://github.com/edeng23/binance-trade-bot)) is fine to go with.

Place youself in the previously created directory, e.g.:
```bash
cd ~/trading-bot
```

To begin with, open a terminal and place yourself in the directory where the binance-trade-bot is already present, e.g. if the binance_trade_bot directory is located in `/home/user/trading_bot` run:
```console
cd /home/user/trading_bot
Then follow the install instruction given on the binance-trade-bot's readme. **Setup telegram bot during the install of binance-trade-bot (see the section `Notifications with Apprise` in the README)**

Once the binance-trade-bot has been installed, make sure everything is properly installed : the following commands should yeild no errors.
```
cd ~/trading-bot
ls binance-trade-bot/binance_trade_bot/__main__.py
ls binance-trade-bot/config/apprise.yml
```

### 2 - Install the telegram manager next to the binance trade bot
As always, place youself in the install directory, e.g.:
```bash
cd ~/trading-bot
```

Then, run the following lines:
```console
git clone https://github.com/lorcalhost/BTB-manager-telegram.git
cd BTB-manager-telegram
python3 -m pip install -r requirements.txt
```

## Usage
## Other Install Methods
### Automated Install
For an automated install, please refer to [Enriko82's Install Script](https://github.com/Enriko82/BTB-Install-script)

### Docker Install
**This method is discouraged as it is no longer maintained.**
*If you crave to contain the bot and its manager, you can always use python's virtual environments.*
However, you can still find a docker setup guide [here](./docs/docker-setup.md).

## Usage
As the telegram bot is launching itself the **Binance Trade Bot**, you only have to start the **BTB Manager Telegram** like so:

```console
Expand Down Expand Up @@ -122,17 +145,6 @@ Severa known problems are present on **native Windows** and will not be asserted
</p>
</details>

## Support the project
If you like the **BTB manager telegram** and use it on a daily basis consider supporting the project through a small donation. :smile:

[:heart: Sponsor on GitHub](https://github.com/sponsors/lorcalhost)

<a href="https://www.buymeacoffee.com/lorcalhost">
<img src="https://img.buymeacoffee.com/button-api/?text=Buy me a beer&emoji=🍺&slug=lorcalhost&button_colour=FFDD00&font_colour=000000&font_family=Lato&outline_colour=000000&coffee_colour=ffffff">
</a>

_Donations through GitHub sponsors will be matched by GitHub (e.g. if you decide to donate 10$, GitHub will add 10$ to the donation)._

## Contributions and feature requests

If you have any feature requests please [open an issue].
Expand Down
1 change: 0 additions & 1 deletion btb_manager_telegram/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,6 @@ def main() -> None:
f"{i18n.t('welcome.welcome')}\n\n"
f"{i18n.t('welcome.developed_by', contributors=contributors)}\n"
f"{i18n.t('welcome.project_link')}\n\n"
f"{i18n.t('welcome.donation')}\n\n"
f"{message_trade_bot}"
f"{i18n.t('welcome.how_to_start')}"
)
Expand Down
1 change: 0 additions & 1 deletion locales/cn.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "欢迎来到 _Binance Trade Bot Manager Telegram_."
developed_by: "这个机器人由这些贡献者打造 %{contributors}."
project_link: "关于这个的 [更多信息](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*如果你觉得我做的不错的话请考虑 [通过赞助来支持我](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*通过`/start`开始对话*"
bot_started: "目前已经有一个机器人在运行,不需要运行多个"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/de.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Willkommen beim _Binance Trade Bot Manager Telegramm_."
developed_by: "Dieser Telegram Bot wurder von %{contributors} entwickelt."
project_link: "Finde [hier](https://github.com/lorcalhost/BTB-manager-telegram) mehr über das Projekt heraus."
donation: "*Wenn du meine Arbeit magst, [überlege bitte das Projekt mit einer kleinen Spende zu unterstützen](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Zum Starten der Unterhaltung, klicke auf die Schaltfläche `/start`*"
bot_started: "Ich habe den Handelsbot bereits für dich gestartet. Das brauchst du nicht mehr machen"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Welcome to _Binance Trade Bot Manager Telegram_."
developed_by: "This Telegram bot was developed by %{contributors}."
project_link: "Find out more about the project [here](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*If you like my work please [consider supporting the project through a small donation](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*To start the conversation, click on the button `/start`*"
bot_started: "I already started the trade bot for you, no need to start it again!"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Bienvenido a _Binance Trade Bot Manager Telegram_."
developed_by: "Este bot fue programado por %{contributors}."
project_link: "Encuentra mas informacion del proyecto [aqui](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*Si te gusta mi trabajo por favor [considera donar al proyecto a través de una pequeña donacion](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Para iniciar una conversación utiliza `/start`*"
bot_started: "La conversación ya inició, no hace falta usar el comando."
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/fr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Bienvenue sur le manager télégram du _Binance Trade Bot_."
developed_by: "Ce bot est développé par %{contributors}."
project_link: "Retrouvez le projet [ici](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*Si vous appréciez mon travail, [supportez moi avec un petit don](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Pour démarrer la discussion, appuyez sur le bouton `/start`*"
bot_started: "J'ai déjà démarré le bot de trading pour vous, pas besoin de le faire!"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Selamat datang di _Telegram Manager_ untuk _Binance Trade Bot_."
developed_by: "Telegram Manager ini dikembangkan oleh %{contributors}."
project_link: "Cari tahu tentang project ini [disini](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*Jika kamu menyukai project ini [silahkan mendukung proyek ini dengan memberikan sedikit donasi](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Untuk memulai percakapan, klik tombol `/start`*"
bot_started: "Binance Trade Bot telah dijalankan secara otomatis"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/nl.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ welcome:
welcome: "Welkom bij de _Binance Trader Bot Telegram Manager_."
developed_by: "Deze Telegram bot is ontwikkeld door %{contributors}."
project_link: "Lees meer over dit project [hier](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*Als je mijn werk leuk vindt, [overweeg dan om het project te ondersteunen door middel van een kleine donatie](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Om het gesprek te starten, klikt u op de knop `/start`*"
bot_started: "Ik heb de handelsbot al voor je gestart, je hoeft hem niet opnieuw te starten!"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/pt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Bem-vindo ao _Binance Trade Bot Manager Telegram_."
developed_by: "Este bot do Telegram é desenvolvido por %{contributors}."
project_link: "Encontra mais sobre este projeto [aqui](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*Se gostas do projeto [considera apoiá-lo com uma pequena doação](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Para iniciar a conversa, clique no butão `/start`*"
bot_started: "Eu ja iniciei o bot de trade para ti, não há necessidade de o iniciar denovo!"
bot_not_started:
Expand Down
1 change: 0 additions & 1 deletion locales/ru.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ welcome:
welcome: "Добро пожаловать в _Binance Trade Bot Manager Telegram_."
developed_by: "Этот бот Telegram был разработан %{contributors}."
project_link: "Узнать больше о проекте [здесь](https://github.com/lorcalhost/BTB-manager-telegram)."
donation: "*Если Вам нравятся мои работы, пожалуйста, рассмотрите возможность поддержки проекта небольшим [пожертвованием](https://github.com/sponsors/lorcalhost). ❤*"
how_to_start: "*Чтобы начать общение, нажмите на кнопку `/start`*"
bot_started: "Я уже запустил для вас торгового бота, не нужно запускать его заново!"
bot_not_started:
Expand Down

0 comments on commit 76ac997

Please sign in to comment.