Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.5b3

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.5b3
File Size Uploaded Provenance Actions
ferogram-0.5.5b3.tar.gz 739.4 kB With provenance Details for ferogram-0.5.5b3.tar.gz

Built distributions (wheels)

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

Total release size: 34.2 MB

Release files / ferogram-0.5.5b3.tar.gz

Download URL ferogram-0.5.5b3.tar.gz
Size 739.4 kB
Tags Source
SHA-256 checksum
How to use checksums
13a84f4a7ccb41a23694904bb625d3a631a6a1276b14aeb4e20556d780e26657
BLAKE2b-256 checksum
How to use checksums
c6c82180347e5ab320803453d160107315c0ce6f71bfa236f3ab41088b8b5698
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-cp39-abi3-win_amd64.whl
Size 4.0 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
61e06827fc2c09099672dbe6ff467bff217e2d2656ba098f2bb849d14b204105
BLAKE2b-256 checksum
How to use checksums
e7c8e841d188494d67c127fea94120498dabf222b7e34f0ec2e346adea50e2b2
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
20a0a79cec444386f47a338cae95ff258c55a23b648fc002bc1512450e9a79eb
BLAKE2b-256 checksum
How to use checksums
960275625a614ddc02a92fddd04411a10fb37366436e99c16833aa652e053467
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
67b01f11030b8f124971dc9a1c72f736dd5faccebfac067d0f35c29ef3244ee5
BLAKE2b-256 checksum
How to use checksums
47c57f35529bb2afef4934365ce59e4830882e35ea90fbfcd8f2d677686e0d81
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
aaa8bc38e6fefe3154428678b6d399f1fa33c55425681a2ccf220a0a3ee6d2a8
BLAKE2b-256 checksum
How to use checksums
398caff24741cc45b6c71596f40e51d318bd50066a3cf8026a4fafbf16c38988
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
5ff9279a4156f61e46866759d57a788d93b58f15e38b1a740c6ad3375c135659
BLAKE2b-256 checksum
How to use checksums
135b853292497f81bf85b7e6df7c120c7cd1ef67ff009e5ee9da30540da2fa29
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
b25058c4af39f7ceba1a12ef3836d92a307e0f31f5c7d7694dd57bc1a2014d55
BLAKE2b-256 checksum
How to use checksums
3d0654cf1453a3816b88a9829a8d4cbcec3fe843ffff798e77ccdbb45934cddf
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
102904486b90caee683d714f82369883d2a37431e5f469f0adbfebdeeeb3bfe1
BLAKE2b-256 checksum
How to use checksums
63c9593fb2b184868e1cffe3dfef80f6647d9773c1e705bb19433a8bdef20b83
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
ca0504675fb5e3293512ba1fa9b929c1251e8eca9d14f0ec5d8bc357c4aa9c78
BLAKE2b-256 checksum
How to use checksums
b59ca949e8f4025bfe346ec7660b98b81848d1b8f618f756b9a44295a9a02739
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 15, 2026.

Transparency log

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

Download URL ferogram-0.5.5b3-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
daef468a598f001517c6dee5746db6af5d46c071e159813c71cf382fd4c5431d
BLAKE2b-256 checksum
How to use checksums
b9727056a373d1a35c757ac2b16c775b697436e6123e6f5d4e7950e5ccee024b
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 15, 2026.

Transparency log

Security for ferogram 0.5.5b3

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.5b3.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 15, 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
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