forwarding-bot 2.5.2

No project description provided

Forwarding bot

Not really scalable, but straightforward one-way VK->TG message forwarding bot

Forward your VK conversation messages to TG

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

pre-commit usage is highly recommended

install hooks via pre-commit install -t=pre-commit -t=pre-push

License

MIT

Documentation

1. Installation
   1. From PyPi
   2. From GitHub
   3. Extras
2. Config
   1. Config source priority
   2. Command-line arguments
   3. INI configs
   4. Environment variables
      1. Using environment variables

Installation

From PyPi

pip install forwarding-bot

From GitHub

git clone https://github.com/dhvcc/forwarding-bot.git
cd forwarding-bot
pip install .

Extras

You can install extra dependencies, such as speedups or dev

pip install forwarding-bot[dev]

# You must be in a directory where setup.py is located
pip install .[speedups]

pip install forwarding-bot[speedups,dev]

Config

Config argument sources are prioritized

1. Command-line arguments
2. Local .forwarding-bot config
3. Environment variables
4. Global {HOME}/.forwarding-bot config

Command-line arguments

To view help on cli arguments you can run forwarding-bot --help

INI configs

Every argument is optional if config and will be grabbed from other source if not present The syntax for config is the following:

[forwarding-bot]
BOT_TOKEN =
USER_TOKEN =
SOURCE_ID =
DESTINATION_ID =

Local/global INI configs must be named .forwarding-bot

Global config must be located in your home folder

Environment variables

Env vars should be prefixed with FORWARDING_BOT_, for example, FORWARDING_BOT_BOT_TOKEN

Using environment variables

Windows

Linux