Skip to main content
# Thumbot
![thumb](http://i.giphy.com/I83tvEbSgRy8M.gif)

**Thumbot** is a :thumbsup: :thumbsdown: counter keyboard for Telegram bots and channels.

![photo31331718161082944](https://cloud.githubusercontent.com/assets/431892/21070814/1a44c100-be75-11e6-9995-06a82bce7e41.jpg)


## Requirements
- Python;
- Your bot/channel must be created with [pyTelegramBotAPI](https://github.com/eternnoir/pyTelegramBotAPI);
- MongoDB;


## Running

- Your're going to need to run an instance of [MongoDB](https://mongodb.com). For tests porpuse (or even production, but with some concerns) you can use [Docker](https://docker.com/) and get a container running in some minutes:

`$ docker run -d -p 27017:27017 mongo`

- To install Thumbot is pretty easy:

`$ pip install thumbot`

- Now, you're ready to include the Thumbot keyboard in your bot or channel!


## Usage
```py
from thumbot import Thumbot

# Create a new instance of Thumbot passing chat and message ids:
thumbot = Thumbot(chat_id, message_id)

# Now you can vote up and down with the methods .up() and .down(),
# always passing the id of the user that is voting:
thumbot.up(user_id)
thumbot.down(user_id)
```

Check out the [example.py](https://github.com/rougeth/thumbot/blob/master/example.py) to see a full working bot using Thumbot.


### Bots and Channels using Thumbot:
- [@on_sale](https://telegram.me/on_sale)

Metadata

Release files for thumbot 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for thumbot 0.1.0
File Size Uploaded Provenance Actions
thumbot-0.1.0.tar.gz 2.4 kB Without provenance Details for thumbot-0.1.0.tar.gz

Release files / thumbot-0.1.0.tar.gz

Download URL thumbot-0.1.0.tar.gz
Size 2.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8c521ffc9be4c46a6237a69246f2ce41472a4bb52451991f61767abbf5925626
BLAKE2b-256 checksum
How to use checksums
8f24f3451f0d8d56750a87bf4bb4569ce4bd904cf35136bb0dc52a7e7da8a07f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for thumbot 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page