Skip to main content

Telegram Bot Short Message Service: Small requests wrapper to send message to chat via Telegram Bot API

Project description

tgbsms - Telegram Bot Short Message Service

tgbsms is a simple Python utility for sending short messages via Telegram using the Telegram Bot API.

Features

  • Trims the text to fit Telegram's maximum length
  • Sends POST request to Telegram bot API

Installation

You can install tgbsms directly from PyPI using pip:

pip install tgbsms

Usage

To send a message using the tgbsms, you can use the send_message function. Here is an example:

from tgbsms import send_message

send_message("test", telegram_chat_id="<chat_id>", telegram_bot_token="<your_bot_token>")

Parameters:

  • text: The message to send (string). If the message exceeds 4000 characters, it will be cropped.
  • telegram_chat_id: (Optional, read below) The ID of the chat where the message will be sent. This can be an integer or a string.
  • telegram_bot_token: (Optional, read below) Your bot's TOKEN provided by Telegram.

Environment Variables

If you prefer not to pass the telegram_bot_token and telegram_chat_id directly, you can set them as environment variables:

  • TELEGRAM_BOT_TOKEN: Your Telegram bot's TOKEN.
  • TELEGRAM_CHAT_ID: The chat ID for the message.

Once the environment variables are set, the function can be used without passing these parameters directly.

export TELEGRAM_BOT_TOKEN="<your_bot_token>"
export TELEGRAM_CHAT_ID="<chat_id>"

And then:

from tgbsms import send_message

send_message("test")

License

This project is licensed under the MIT License. See the LICENSE file 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

tgbsms-1.0.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

tgbsms-1.0.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file tgbsms-1.0.0.tar.gz.

File metadata

  • Download URL: tgbsms-1.0.0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.5

File hashes

Hashes for tgbsms-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ec75056636d1324b8d765668b2644d9f5ce8b9284cdf31902a0ab98215e5f61d
MD5 8854d046e5f77652c46ef165f97e2930
BLAKE2b-256 292a32dda993bd871b906485289448dfe55c25c4d6dca346f619c636fcb79928

See more details on using hashes here.

File details

Details for the file tgbsms-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: tgbsms-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.5

File hashes

Hashes for tgbsms-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14697e911280b3cd2c1a5574eb012849902415a7beff515a629f6f72efefadb6
MD5 0f71e50dab7065652e7dd0136d8051fc
BLAKE2b-256 57256c5a06e626c52756e82454a1116e79f03de693bb07b6e87d9490d91f0ef2

See more details on using hashes here.

Supported by

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