Metadata-Version: 2.1
Name: efb-telegram-slave
Version: 0.1.1
Summary: Telegram Save Channel for EH Forwarder Bot, based on Telethon
Home-page: https://github.com/SharzyL/efb-telegram-slave
Author: Sharzy L
Author-email: me@sharzy.in
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# EFB Telegram Slave

[EH Forwarder Bot](https://github.com/ehForwarderBot) is an extensible message
tunneling chat bot framework.

It is sometimes useful if we have a Telegram slave channel for EFB. So there is
one, primarily based on [telethon](https://docs.telethon.dev). 

**Channel ID**: `sharzy.telegram`

## Installation

Install the latest version from GitHub (recommended because this project is not stable yet):  

`pip3 install git+https://github.com/SharzyL/efb-telegram-slave`

Install from PyPI:

`pip3 install efb-telegram-slave`

To make EFB work, you need to configure some master channel and some slave
channels.  For complete usage guide, refer to [EFB user
guide](https://ehforwarderbot.readthedocs.io/en/latest/getting-started.html). 

## Configuration

Run `ehforwaderbot --profile <your-profile-name>` to run an interactive guide to 
complete the configuration. 

By default, configuration file is located in
`~/.ehforwarderbot/profiles/<your-profile-name>/sharzy.telegram/config.yaml`.
The following is an exemplary configuration. 

```yaml
# you should apply for a pair of api_hash and api_id in https://my.telegram.org/
api_hash: 12349061a3e1383920c2e05c1830a774
api_id: 1234567

# in case you need a proxy to access telegram
proxy: 
  protocol: http  # http / socks5 / socks4
  host: localhost
  port: 1234
```

## Features not supported yet

1. Rich text
2. Less used message types, such as Location 
3. Message edit and recall
4. Send sticker as `.webp`
5. Notification control

