tgpost

Send messages and files to Telegram channels, now or on a schedule.

Disclaimer

Provided AS IS, without warranty of any kind, express or implied. Use entirely at your own risk. The author accepts no liability for data loss, content published to the wrong channel or audience, business interruption or consequential damages.

You are responsible for verifying the target channel, for what you publish, for being authorised to post there, and for complying with the Telegram Terms of Service. tgpost schedule and tgpost daemon publish unattended: a mistaken cron expression can post to a live channel repeatedly until someone stops it. Test against a private channel first.

Not certified for regulated, forensic, safety-critical or high-assurance use. There is no delivery guarantee: the Bot API offers no idempotency key, so a send that times out may or may not have arrived.

The MIT LICENSE is the governing text and prevails wherever this summary differs from it. See DISCLAIMER.md for the full text.

Why this exists

Sending a file to a Telegram channel from the command line is well covered already. What is missing is doing it later, reliably.

The Telegram HTTP Bot API has no server-side scheduling: there is no schedule_date parameter on any send method, so "post this at 9am on weekdays" has to be solved on your side, and survive a reboot. tgpost is a sender with a persistent job store attached, so a scheduled post still goes out after the machine restarts.

If you only need to send something right now, telegram-send and apprise both do that well.

Install

pip install tgpost              # sending only
pip install tgpost[schedule]    # sending and scheduling

Requires Python 3.11 or newer.

Getting started

Create a bot with @BotFather, then add it to your channel as an administrator with permission to post messages. A bot cannot post to a channel as an ordinary member.

export TGPOST_BOT_TOKEN="123456789:your-token-here"     # Windows: set TGPOST_BOT_TOKEN=...

tgpost targets add release-notes -1001234567890 --description "Build announcements"
tgpost check

tgpost check verifies the token and reports, per target, whether the bot can actually post. Those two permission failures are the most common cause of a send failing later, so it is worth running first.

Finding a channel id

A public channel can be addressed as @channelusername. For a private channel, post any message in it, then read the numeric id (it starts with -100):

tgpost targets add private-chan @temporary_username   # if public, then:
tgpost check                                          # prints the numeric id

Sending

tgpost send --to release-notes --text "Build 1.2.3 shipped"
tgpost send --to release-notes --file build.zip --caption "Nightly build"
tgpost send --to release-notes --file a.png --file b.png --album --kind photo
git log --oneline -10 | tgpost send --to release-notes --stdin
tgpost send --to release-notes --text "check this first" --dry-run

Text longer than Telegram's 4096-character limit is split across several messages at paragraph, line or word boundaries.

Scheduling

tgpost schedule --to release-notes --text "Standup" --cron "0 9 * * 1-5" --tz Europe/London
tgpost schedule --to alerts --text "Still alive" --every 30m
tgpost schedule --to release-notes --file report.pdf --at "2026-09-10T14:00"
tgpost schedule --to alerts --text "in two hours" --at 2h

tgpost jobs          # what is scheduled, and when each next runs
tgpost history       # what actually happened
tgpost cancel a41a4c18

Jobs are stored in SQLite and survive a restart. Something has to run them:

tgpost daemon        # long-running: keeps firing jobs until stopped
tgpost run-due       # fires everything due, then exits

Use daemon on a machine that stays up. Use run-due from Windows Task Scheduler or cron if you would rather not keep a process alive:

schtasks /create /tn "tgpost" /tr "tgpost run-due" /sc minute /mo 5

A job whose time passed while nothing was running still fires when the scheduler comes back, as long as it is within the one-hour grace window. Missed repeats are coalesced, so a weekend of downtime sends once rather than fifty times.

Formatting

The default parse mode is HTML, because it only requires &, < and > to be escaped. MarkdownV2 requires eighteen characters to be escaped, including ., - and !, which appear in ordinary prose, and a single missed escape is a hard error rather than a cosmetic one.

tgpost send --to alerts --text "<b>Deploy finished</b>"        # markup as written
tgpost send --to alerts --text "$RAW" --escape                 # escape untrusted text
tgpost send --to alerts --text "plain" --parse-mode none

Pass --escape for text you did not write yourself. Without it, the text is sent as markup and a stray < will be rejected by Telegram.

Configuration

Config lives at %APPDATA%\tgpost\config.toml on Windows, or ~/.config/tgpost/config.toml elsewhere.

[defaults]
parse_mode = "html"
base_url = "https://api.telegram.org"

[targets.release-notes]
chat_id = "-1001234567890"
description = "Build announcements"

[targets.alerts]
chat_id = "@my_public_channel"
parse_mode = "none"

The token is read from --token, then TGPOST_BOT_TOKEN, then the config file. tgpost targets add never writes the token to disk, so a token supplied on the command line or in the environment is not persisted by accident.

Limits

Set by the Bot API, not by this package:

tgpost paces sends to stay under the rate limits, and on a 429 waits exactly the retry_after Telegram asks for rather than guessing.

To send files larger than 50 MB, run a local Bot API server, which raises the limit to 2000 MB, and point tgpost at it:

tgpost --base-url http://127.0.0.1:8081 send --to release-notes --file big.iso

Python API

from tgpost import TelegramClient

with TelegramClient("123456789:your-token") as client:
    client.send_message("-1001234567890", "Build finished")
    client.send_file("-1001234567890", "report.pdf", caption="Nightly report")

Errors derive from TgPostError: AuthError, ForbiddenError, BadRequestError, RateLimitError, ServerError, NetworkError, FileTooLargeError, ConfigError and SchedulerError. Retryable failures are retried internally; what reaches you is a failure worth acting on.

License

MIT. See LICENSE.