Skip to main content

ferogram-py

PyPI Python Downloads License Telegram

A modern, elegant, asynchronous MTProto framework for building Telegram clients and bots in Python.

Powered by a high-performance Rust core that takes care of networking, encryption, TL parsing, and session management so you can focus on writing clean, idiomatic Python.


Why ferogram-py?

Most of the heavy lifting in an MTProto client happens behind the scenes; networking, encryption, TL parsing, and keeping up with updates. ferogram-py lets a Rust core handle all of that, while exposing a clean, Pythonic API.

For most applications, the high-level API is all you'll need. But if you want to use a brand-new Telegram feature or need something more advanced, you can always drop down to the raw MTProto API and invoke requests directly.

The goal is to stay out of your way: simple things should be simple, and advanced things should still be possible.

Quick API reference: FEATURES.md


Install

pip install ferogram
Building from source
make dev      # editable install into .venv (builds the Rust extension)
make build    # release wheel for this machine
make codegen  # regenerate TL code without a Rust rebuild
make test     # run tests
make clean    # wipe .venv, target, dist, generated/

On Termux: pkg install rust clang python first. Rust-only change, don't want to wait on codegen: FEROGRAM_SKIP_CODEGEN=1 maturin develop


Quick start

Bot:

from ferogram import Client, filters

app = Client("mybot", api_id=0, api_hash="", bot_token="123:TOKEN")

@app.on_message(filters.command("start"))
async def start(client, message):
    await message.reply("Hello!")

app.run()

User:

import asyncio
from ferogram import Client

app = Client("myaccount", api_id=0, api_hash="", phone="+1234567890")

async def main():
    async with app as client:
        await client.send_message("me", "logged in")

asyncio.run(main())

Credentials also work from env vars: API_ID, API_HASH, BOT_TOKEN.

Logging

import ferogram.logging as fero_log

fero_log.setup()           # INFO to stderr
fero_log.setup(level=10)   # DEBUG

Architecture

architecture

The compiled extension (_ferogram.so) stays deliberately small: networking, encryption, session storage, and MTProto internals live in Rust. Everything you touch day to day, the client, handlers, filters, is plain Python and can change without a recompile.

Prebuilt Wheels for your platform

Wheels ship prebuilt for Linux (x86_64, aarch64), macOS (x86_64, arm64), Windows (x86_64), and Android/Termux (aarch64, x86_64). pip install ferogram grabs the right one on its own.


License

This project is dual-licensed under:

  • MIT License
  • Apache License 2.0

You may choose either license.

You are free to use, modify, and distribute this software, including for commercial use, provided the original license and copyright notice are included.

See LICENSE-MIT and LICENSE-APACHE for full details.


Developer

Developed by Ankit Chaubey

Don't forget to explore the Rust engine powering ferogram-py: ferogram. Thanks for being part of the journey.

Join the ferogram community! Questions, discussions, bugs report and feedback are always welcome. As the project grows, we'll eventually split Python and Rust discussions into dedicated spaces.

Metadata

Release files for ferogram 0.5.5

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

Source distribution (sdist)

Source distribution for ferogram 0.5.5
File Size Uploaded Provenance Actions
ferogram-0.5.5.tar.gz 740.6 kB With provenance Details for ferogram-0.5.5.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for ferogram 0.5.5
File Actions
ferogram-0.5.5-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details for ferogram-0.5.5-cp39-abi3-win_amd64.whl
ferogram-0.5.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details for ferogram-0.5.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
ferogram-0.5.5-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details for ferogram-0.5.5-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
ferogram-0.5.5-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details for ferogram-0.5.5-cp39-abi3-macosx_11_0_arm64.whl
ferogram-0.5.5-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details for ferogram-0.5.5-cp39-abi3-macosx_10_12_x86_64.whl
ferogram-0.5.5-cp39-abi3-android_24_x86_64.whl CPython 3.9 abi3 Android API level 24+ x86-64 Details for ferogram-0.5.5-cp39-abi3-android_24_x86_64.whl
ferogram-0.5.5-cp39-abi3-android_24_x86.whl CPython 3.9 abi3 Android API level 24+ x86-32 Details for ferogram-0.5.5-cp39-abi3-android_24_x86.whl
ferogram-0.5.5-cp39-abi3-android_24_armeabi_v7a.whl CPython 3.9 abi3 Android API level 24+ ARM EABI v7a Details for ferogram-0.5.5-cp39-abi3-android_24_armeabi_v7a.whl
ferogram-0.5.5-cp39-abi3-android_24_arm64_v8a.whl CPython 3.9 abi3 Android API level 24+ ARM64 v8a Details for ferogram-0.5.5-cp39-abi3-android_24_arm64_v8a.whl

Total release size: 34.2 MB

Release files / ferogram-0.5.5.tar.gz

Download URL ferogram-0.5.5.tar.gz
Size 740.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2f1018891ca830002f100244abe0f81c569e7604659cb28e646385dcb2c1d4d5
BLAKE2b-256 checksum
How to use checksums
1e3df1ae8cbda4fbe86652ccaf5080b62fa070ad09b64efc05356b2fc8cb4d49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-win_amd64.whl

Download URL ferogram-0.5.5-cp39-abi3-win_amd64.whl
Size 4.0 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
aba222bbf5258a85bfad7a1e00a3f4d9391f2618548e84f40820abd018e57498
BLAKE2b-256 checksum
How to use checksums
489edaa89b27b4beff3d9bb49c8ccb68e14005103827d9e5ff4cddb2a82384e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL ferogram-0.5.5-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 3.9 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
5921b2762eb94d930e39e745edfce70160b9194bc7564febf06435e223561769
BLAKE2b-256 checksum
How to use checksums
b0aad0121307bba2f8e2640d244809d38d624bdad8a567dfcafd69d68a457194
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL ferogram-0.5.5-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 3.5 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
f796c89ad0475bdf650339121b2fb607f9883161d7260b5dabfab46e2234ef88
BLAKE2b-256 checksum
How to use checksums
faf62906a92c7c8741c8ee73bb28e964a2975a4089699eb8a330150cb5fe553b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-macosx_11_0_arm64.whl

Download URL ferogram-0.5.5-cp39-abi3-macosx_11_0_arm64.whl
Size 3.5 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d9b5bd1c5715a0ac0b451cd5a163c6102f8612f6b4ffcc31853671a13e3a7cf7
BLAKE2b-256 checksum
How to use checksums
4567c9a4a21bd3fcbfba7eefc7141e0b09f7ce1ce0efd057b557df04271b8560
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-macosx_10_12_x86_64.whl

Download URL ferogram-0.5.5-cp39-abi3-macosx_10_12_x86_64.whl
Size 3.7 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
66bf4db6ab9f173caecf824ce4d8f9e8a323e280c17f5f47a051cfe9bd3a6d3e
BLAKE2b-256 checksum
How to use checksums
8c9292d280d14b9becc2a1eaf95204698667bbf6b8483216cb838aed4d922943
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-android_24_x86_64.whl

Download URL ferogram-0.5.5-cp39-abi3-android_24_x86_64.whl
Size 3.8 MB
Tags Android API level 24+ x86-64 CPython 3.9 abi3
SHA-256 checksum
How to use checksums
423e749e9c57cf031280330f71e75919f25b8704683bf0e6ebe490f18278199f
BLAKE2b-256 checksum
How to use checksums
c9efc488c7e70f34d44d6d45385ba871e162dba3f878f051157f999c57bc1866
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-android_24_x86.whl

Download URL ferogram-0.5.5-cp39-abi3-android_24_x86.whl
Size 3.9 MB
Tags Android API level 24+ x86-32 CPython 3.9 abi3
SHA-256 checksum
How to use checksums
122171e60d46e4ff6311e3d1e30c7d9983b2db64ae6482b254da9f90762b4065
BLAKE2b-256 checksum
How to use checksums
847ed04fe3f4d38f1fa9b106adbde75cdc55fc1e2113280681ffdcd2194029a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-android_24_armeabi_v7a.whl

Download URL ferogram-0.5.5-cp39-abi3-android_24_armeabi_v7a.whl
Size 3.5 MB
Tags Android API level 24+ ARM EABI v7a CPython 3.9 abi3
SHA-256 checksum
How to use checksums
e0feb1a9aa782a88053d3f510a8fd244e9472d280b75ed5276bc520f0888e1d6
BLAKE2b-256 checksum
How to use checksums
507960cd5b925edf3505a14dd7c5cf31f1517c87e925e3a69891d5ec40014928
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / ferogram-0.5.5-cp39-abi3-android_24_arm64_v8a.whl

Download URL ferogram-0.5.5-cp39-abi3-android_24_arm64_v8a.whl
Size 3.6 MB
Tags Android API level 24+ ARM64 v8a CPython 3.9 abi3
SHA-256 checksum
How to use checksums
52b7be980f5a3027cce02e0fdcc720495d493344d119e7b0a7d91917de57bed6
BLAKE2b-256 checksum
How to use checksums
1b6fbee2a3394d77c18996cc84c8cb7021f48fc6d3bb6db3d02dd1a04942fefe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for ferogram 0.5.5

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.

Full provenance

All 10 files in this release have been uploaded with provenance metadata.

Select from 10 files

Attestation for ferogram-0.5.5.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

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.5.5 This release

10 release files Full 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