Skip to main content

Python Telegram Bot Api Wrapper.

Project description

What is telegrambotapiwrapper?

telegrambotapiwrapper is Telegram Bot Api implementation for Python

Requirements

Python 3.7 or Python 3.8

Installation

pip install telegrambotapiwrapper

Getting started.

Creating a bot

You must create a bot and get a token

Testing your bot's auth token

We use the method getMe:

>>> from telegrambotapiwrapper import Api
>>> first_bot_api = Api(token="<paste your token here>")
>>> me = first_bot_api.get_me()
>>> me
User(id=123456679, is_bot=True, first_name='botbotbot', last_name=None, username='myrudatingposterbot', language_code=None)

Check result type:

>>> from telegrambotapiwrapper.typelib import User
>>> isinstance(me, User)
True

Sending a text message to channel

Preconditions

Before sending a text message to a channel, you must:

  1. create channel
  2. add bot to channel as administrator
  3. get channel id

Sending to the channel

>>> first_bot_api.send_message(chat_id=-12345678912345, text="sdjfhjsdfbjdbvhj")
Message(message_id=299, date=1558966491, chat=Chat(id=--12345678912345, type='channel', title='FooFoo', username='lalalalalalala', first_name=None, last_name=None, all_members_are_administrators=None, photo=None, description=None, invite_link=None, pinned_message=None, sticker_set_name=None, can_set_sticker_set=None), from_user=None, forward_from=None, forward_from_chat=None, forward_from_message_id=None, forward_signature=None, forward_sender_name=None, forward_date=None, reply_to_message=None, edit_date=None, media_group_id=None, author_signature=None, text='sdjfhjsdfbjdbvhj', entities=None, caption_entities=None, audio=None, document=None, animation=None, game=None, photo=None, sticker=None, video=None, voice=None, video_note=None, caption=None, contact=None, location=None, venue=None, poll=None, new_chat_members=None, left_chat_member=None, new_chat_title=None, new_chat_photo=None, delete_chat_photo=None, group_chat_created=None, supergroup_chat_created=None, channel_chat_created=None, migrate_to_chat_id=None, migrate_from_chat_id=None, pinned_message=None, invoice=None, successful_payment=None, connected_website=None, passport_data=None)

Note that chat_id is negative.

Sending a photo to channel

>>> with open('/home/dzmitry/Pictures/500800998.jpg', 'rb') as image:
...    first_bot_api.send_photo(chat_id=-12345678912345, photo=image,
...                             caption="hello world")

>>>

Note the open file mode.

Method and types

  • Implemented all methods Telegram Bot Api
  • Implemented all types Telegram Bot Api
  • All types of Telegram Bot Api are imported from the typelib module.

License

MIT License Copyright (c) 2019 Dzmitry Maliuzhenets

See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telegrambotapiwrapper-0.4.4.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telegrambotapiwrapper-0.4.4-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

Details for the file telegrambotapiwrapper-0.4.4.tar.gz.

File metadata

  • Download URL: telegrambotapiwrapper-0.4.4.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.2

File hashes

Hashes for telegrambotapiwrapper-0.4.4.tar.gz
Algorithm Hash digest
SHA256 0251cea2e52873668cda11c3ab0983c2659c8943c5bc91782859b3441fa1c6a7
MD5 fbdd8fce9dc6195851ac1dcaff805417
BLAKE2b-256 8f272cae8a45d18dddd890b0c9e1f6a6142c59707c7419ca80be3aa2c6fd90ac

See more details on using hashes here.

File details

Details for the file telegrambotapiwrapper-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: telegrambotapiwrapper-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 35.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.2

File hashes

Hashes for telegrambotapiwrapper-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f46a6f53bff9cfbca4289fd9b45de7d407142403ee147d54ca484ba5bbb9cff7
MD5 563f9b0f9a60bcb9045b7528052fd45e
BLAKE2b-256 28903435113cb7f69b6ddb0b3c007a4d12ac3dd49dd9b04c80ab5652f2b8382f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page