Metadata-Version: 2.0
Name: ubot
Version: 1.2.2
Summary: Basic, easily extendable, Telegram bot class
Home-page: https://github.com/strychnide/ubot
Author: Alessandro Cerruti
Author-email: thereap3r97@gmail.com
License: MIT
Description-Content-Type: text/markdown
Platform: UNKNOWN
Requires-Python: >=3.5
Requires-Dist: urllib3
Requires-Dist: certifi
Provides-Extra: dev
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: flake8-sorted-keys; extra == 'dev'
Requires-Dist: flake8-import-order; extra == 'dev'
Requires-Dist: flake8-quotes; extra == 'dev'
Requires-Dist: flake8-bugbear; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'

########
Microbot
########

A *very* minimal class that implements the basic Telegram bot functionalities.
Can (should) be extended depending on needs.

Quickstart
==========

To install the dependencies inside a virtualenv run ``make install`` (requires pipenv).

The webhook must be manually set with a GET to the following URL:
https://api.telegram.org:443/bot<token>/setWebhook?url=<webhook_url>
where <token> is the Telegram-given token and <webhook_url> is the url you want the webhook to point to.
In case you want to reset it, just GET to the same url without parameters.

Docs (work in progress): https://strychnide.github.io/ubot/

**TODO:** documentation, testing

