Skip to main content

tgcli is a client tool for Telegram.

Project description

tgcli

PyPI PyPI PyPI PyPI Telegram Code Style

tgcli is a Python cli app for Telegram.

Build Coverage
Master Travis (.com) master
Development Travis (.com) development

Installing

Install via pip:

pip install tgcli

Rationale

A similar project, built on Python, was created by @vysheng, but it has not been updated since 2016 and considered abandoned. This tool is not a fork of the mentioned project, it is built from ground up.

Example

For now, the use case is pretty simple. To send a message:

tgcli bot --token "BotToken" send --receiver "UserID" message "Your message"

You don't need to expose your token as flag. If you set TELEGRAM_BOT_TOKEN environment variable, you do not need to set --token flag. Just set it before using tgcli:

export TELEGRAM_BOT_TOKEN="BotToken"

You can get more information by doing:

tgcli bot send --help

Also, this repository uses notification from a private bot, you can see the example Travis configuration here. Private TELEGRAM_BOT_TOKEN and TELEGRAM_RECEIVER environment variables were set.

This application serves a really small purpose for now. It might face breaking changes in the future.

Documentation

Documentation has an intensive amount of information about how to use tgcli. Refer to the documentation.

Donations

tgcli is a free (as in beer and speech) software that I have built in my leisure time and been maintaining it. If you like to use it, please consider a small donation.

How do I donate?

I accept donations in:

  • MiliBitcoin (mBTC)
  • Monero (XMR)

You can donate predefined (almost $1) or custom donation by clicking or scanning below.

Predefined (Almost $1) How Much You Wish
MiliBitcoin (mBTC) mBTC predefined mBTC custom
Monero (XMR) XMR predefined XMR custom

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

tgcli-0.3.1.tar.gz (8.7 kB view details)

Uploaded Source

File details

Details for the file tgcli-0.3.1.tar.gz.

File metadata

  • Download URL: tgcli-0.3.1.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for tgcli-0.3.1.tar.gz
Algorithm Hash digest
SHA256 217acf2badff3d9fafbf6bc8de69306d6dfdf08bdbaa7ccb39eeeb345cac3c73
MD5 95bfed9c16e031adf4ef0c4c5a01c8fd
BLAKE2b-256 4db2d508e4a7f3d4ccd77cc070c908bc440dc1a9a1705e309e292fff0a412668

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