simplebot-tggroups


Namesimplebot-tggroups JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://github.com/simplebot-org/simplebot_tggroups
SummaryBridge Telegram groups with DeltaChat groups.
upload_time2023-11-15 11:23:42
maintainer
docs_urlNone
authoradbenitez
requires_python
licenseMPL
keywords simplebot plugin deltachat telegram bridge
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Telegram Groups Bridge
======================

.. image:: https://img.shields.io/pypi/v/simplebot_tggroups.svg
   :target: https://pypi.org/project/simplebot_tggroups

.. image:: https://img.shields.io/pypi/pyversions/simplebot_tggroups.svg
   :target: https://pypi.org/project/simplebot_tggroups

.. image:: https://pepy.tech/badge/simplebot_tggroups
   :target: https://pepy.tech/project/simplebot_tggroups

.. image:: https://img.shields.io/pypi/l/simplebot_tggroups.svg
   :target: https://pypi.org/project/simplebot_tggroups

.. image:: https://github.com/simplebot-org/simplebot_tggroups/actions/workflows/python-ci.yml/badge.svg
   :target: https://github.com/simplebot-org/simplebot_tggroups/actions/workflows/python-ci.yml

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black

A `SimpleBot`_ plugin that allows to bridge Telegram and Delta Chat groups.

    For channel subscriptions use: https://github.com/simplebot-org/simplebot_tgchan

Installation
------------

To install run::

  pip install simplebot-tggroups

To convert Delta Chat voice messages to mp3 before sending them to the Telegram side,
`pydub <https://github.com/jiaaro/pydub>`_ is used, you might need to install ``ffmpeg`` in your
system, check: https://github.com/jiaaro/pydub#dependencies, for example to install it in an
apt-based system::

  sudo apt install ffmpeg

Configuration
-------------

See https://github.com/simplebot-org/simplebot to know how to configure the bot with an e-mail account.

Before you start using the bot, you need to get your own API ID and hash, go to https://my.telegram.org,
you also need a bot token, got to `@BotFather <https://t.me/botfather>`_ on Telegram and create a bot,
then to set API ID, API hash and bot token, execute::

    simplebot -a bot@example.com telegram

After configuration you can start the bot::

    simplebot -a bot@example.com serve

Then you can start bridging Telegram and Delta Chat groups, send ``/help`` to the bot in Delta Chat for
more info.

To bridge a Telegram group to a Delta Chat group:

1. Add the bot in Telegram to your group.
2. Send ``/id`` command in the Telegram group, copy the ID returned by the bot.
3. Add the bot in Delta Chat to your group.
4. Send ``/bridge 1234`` where ``1234`` is the group ID obtained in the Telegram group.
5. Then all messages sent in both groups will be relayed to the other side.

Tweaking Default Configuration
------------------------------

You can tweak the maximum size (in bytes) of attachments the bot will bridge::

    simplebot -a bot@example.com telegram --max-size 5242880

By default the bot will download attachments of up to 5MB.


.. _SimpleBot: https://github.com/simplebot-org/simplebot

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/simplebot-org/simplebot_tggroups",
    "name": "simplebot-tggroups",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "simplebot plugin deltachat telegram bridge",
    "author": "adbenitez",
    "author_email": "adbenitez@nauta.cu",
    "download_url": "https://files.pythonhosted.org/packages/90/aa/88d1b42440fc41396ef33aba50003581dba5aa6a342db205bfb513c843f4/simplebot_tggroups-0.3.0.tar.gz",
    "platform": null,
    "description": "Telegram Groups Bridge\n======================\n\n.. image:: https://img.shields.io/pypi/v/simplebot_tggroups.svg\n   :target: https://pypi.org/project/simplebot_tggroups\n\n.. image:: https://img.shields.io/pypi/pyversions/simplebot_tggroups.svg\n   :target: https://pypi.org/project/simplebot_tggroups\n\n.. image:: https://pepy.tech/badge/simplebot_tggroups\n   :target: https://pepy.tech/project/simplebot_tggroups\n\n.. image:: https://img.shields.io/pypi/l/simplebot_tggroups.svg\n   :target: https://pypi.org/project/simplebot_tggroups\n\n.. image:: https://github.com/simplebot-org/simplebot_tggroups/actions/workflows/python-ci.yml/badge.svg\n   :target: https://github.com/simplebot-org/simplebot_tggroups/actions/workflows/python-ci.yml\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n\nA `SimpleBot`_ plugin that allows to bridge Telegram and Delta Chat groups.\n\n    For channel subscriptions use: https://github.com/simplebot-org/simplebot_tgchan\n\nInstallation\n------------\n\nTo install run::\n\n  pip install simplebot-tggroups\n\nTo convert Delta Chat voice messages to mp3 before sending them to the Telegram side,\n`pydub <https://github.com/jiaaro/pydub>`_ is used, you might need to install ``ffmpeg`` in your\nsystem, check: https://github.com/jiaaro/pydub#dependencies, for example to install it in an\napt-based system::\n\n  sudo apt install ffmpeg\n\nConfiguration\n-------------\n\nSee https://github.com/simplebot-org/simplebot to know how to configure the bot with an e-mail account.\n\nBefore you start using the bot, you need to get your own API ID and hash, go to https://my.telegram.org,\nyou also need a bot token, got to `@BotFather <https://t.me/botfather>`_ on Telegram and create a bot,\nthen to set API ID, API hash and bot token, execute::\n\n    simplebot -a bot@example.com telegram\n\nAfter configuration you can start the bot::\n\n    simplebot -a bot@example.com serve\n\nThen you can start bridging Telegram and Delta Chat groups, send ``/help`` to the bot in Delta Chat for\nmore info.\n\nTo bridge a Telegram group to a Delta Chat group:\n\n1. Add the bot in Telegram to your group.\n2. Send ``/id`` command in the Telegram group, copy the ID returned by the bot.\n3. Add the bot in Delta Chat to your group.\n4. Send ``/bridge 1234`` where ``1234`` is the group ID obtained in the Telegram group.\n5. Then all messages sent in both groups will be relayed to the other side.\n\nTweaking Default Configuration\n------------------------------\n\nYou can tweak the maximum size (in bytes) of attachments the bot will bridge::\n\n    simplebot -a bot@example.com telegram --max-size 5242880\n\nBy default the bot will download attachments of up to 5MB.\n\n\n.. _SimpleBot: https://github.com/simplebot-org/simplebot\n",
    "bugtrack_url": null,
    "license": "MPL",
    "summary": "Bridge Telegram groups with DeltaChat groups.",
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/simplebot-org/simplebot_tggroups"
    },
    "split_keywords": [
        "simplebot",
        "plugin",
        "deltachat",
        "telegram",
        "bridge"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ae9aef98a170695d6be1aa8b0629d4c47608011788b0cc4d4e221ee57a477bf1",
                "md5": "9ef58f40f65e505def19503b6fa49cd5",
                "sha256": "bd8c83ecc205742eddd7e21dde97e188b48dc7e20adae0041bee571e8f647de5"
            },
            "downloads": -1,
            "filename": "simplebot_tggroups-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ef58f40f65e505def19503b6fa49cd5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14716,
            "upload_time": "2023-11-15T11:23:40",
            "upload_time_iso_8601": "2023-11-15T11:23:40.318343Z",
            "url": "https://files.pythonhosted.org/packages/ae/9a/ef98a170695d6be1aa8b0629d4c47608011788b0cc4d4e221ee57a477bf1/simplebot_tggroups-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "90aa88d1b42440fc41396ef33aba50003581dba5aa6a342db205bfb513c843f4",
                "md5": "343954548035665b3ce6640cc81ee00f",
                "sha256": "88c1671bdd3a92bbdbaf01c903de875f668d33cbdfea2faea8d87d3cb12a92d7"
            },
            "downloads": -1,
            "filename": "simplebot_tggroups-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "343954548035665b3ce6640cc81ee00f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17287,
            "upload_time": "2023-11-15T11:23:42",
            "upload_time_iso_8601": "2023-11-15T11:23:42.158066Z",
            "url": "https://files.pythonhosted.org/packages/90/aa/88d1b42440fc41396ef33aba50003581dba5aa6a342db205bfb513c843f4/simplebot_tggroups-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-15 11:23:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simplebot-org",
    "github_project": "simplebot_tggroups",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "simplebot-tggroups"
}
        
Elapsed time: 3.54889s