semvec/pypi-packages huggingface dataset:
tgbotplug 1.2.12
Telegram plugin-based bot
License: MIT License
Keywords: telegram,bot

tgbotplug is meant to be an easy-to-extend telegram bot built around
`twx.botapi <https://github.com/datamachine/twx.botapi>`__.

Using tgbotplug, after choosing/developing your plugins, is as simple
as:

.. code:: python

    import tgbot
    tgbot.TGBot(
      'YOUR_BOT_TOKEN',
      plugins=[
        Plugin1(),
        ...,
        PluginN(),
      ],
    ).run()

Overview
--------

|PyPI version| |Build Status| |Coverage Status|

1. `Documentation <#documentation>`__
2. `VirtualLife Examples <#virtuallife-examples>`__

Documentation
-------------

Plugins should inherit ``tgbot.pluginbase.TGPluginBase`` and implement
``list_commands()`` (and the methods mapped in its result).

Documentation is a bit scarse (*== None*) at the moment so please focus
on the `plugin
examples <https://github.com/fopina/tgbotplug/tree/master/plugin_examples>`__
and the `VirtualLife Examples <#virtuallife-examples>`__ for now!

VirtualLife Examples
--------------------

-  `PriberamBot <http://fopina.github.io/tgbot-priberambot>`__ - uses
   webhooks, inline queries, packaged for Heroku
-  `ButtieBot <http://fopina.github.io/tgbot-buttiebot>`__ - uses
   webhooks, sends photos, packaged for OpenShift
-  `EuromillionsBot <http://fopina.github.io/tgbot-euromillionsbot>`__ -
   uses webhooks, inline queries, packaged for OpenShift
-  `PushItBot <http://fopina.github.io/tgbot-pushitbot>`__ - uses
   webhooks, extends tgbotplug Bottle app for extra routes, packaged for
   OpenShift
-  `IndieShuffleBot <http://pmpfl.github.io/indieshufflebot>`__ - uses
   webhooks, sends audio, packaged for OpenShift

.. |PyPI version| image:: https://badge.fury.io/py/tgbotplug.svg
   :target: https://badge.fury.io/py/tgbotplug
.. |Build Status| image:: https://travis-ci.org/fopina/tgbotplug.svg?branch=master
   :target: https://travis-ci.org/fopina/tgbotplug
.. |Coverage Status| image:: https://coveralls.io/repos/fopina/tgbotplug/badge.svg?branch=master&service=github
   :target: https://coveralls.io/github/fopina/tgbotplug?branch=master