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

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

Built distributions (wheels)

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

Total release size: 35.0 MB

Release files / ferogram-0.5.5b5.tar.gz

Download URL ferogram-0.5.5b5.tar.gz
Size 803.6 kB
Tags Source
SHA-256 checksum
How to use checksums
19f98af215bf742e17f1be7c007e673b474d19f853353630e7b2fe3b9290c30f
BLAKE2b-256 checksum
How to use checksums
8911bc8f9a8816e4a95e8882f105e437d0375e1cc432f4e76964f647d739d0a7
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-win_amd64.whl

Download URL ferogram-0.5.5b5-cp310-abi3-win_amd64.whl
Size 4.1 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
717153cbfab852cf88a601c4e765caf087f31cd78f095133f3a1910736b76772
BLAKE2b-256 checksum
How to use checksums
5cb693abd03f805e2f060189298261e56e86af8ceef0e7c862afa0358886cd73
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL ferogram-0.5.5b5-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 3.9 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
361011e6b4354f5245192e66c0feb6091b95a5b30f3effe24ebeb478804504be
BLAKE2b-256 checksum
How to use checksums
44c9a70f29f608e454add89235f63512f4bea37966ec431eb074c385febdd5f2
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL ferogram-0.5.5b5-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 3.6 MB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
bc1eb7f5b37db8ce8043b982eedc422a2c9acbf43aeb10d2d39d5132965331a2
BLAKE2b-256 checksum
How to use checksums
b73d9ed58fbf4bc095ba061a480dd00d0dd3f249a29433f0056d4a17ae2073ee
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-macosx_11_0_arm64.whl

Download URL ferogram-0.5.5b5-cp310-abi3-macosx_11_0_arm64.whl
Size 3.6 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
8596fe12efcc6d2b125aaadbe9bf87198e3be6a1bc88cdd8bbf8f8918fc52599
BLAKE2b-256 checksum
How to use checksums
2163fc39680de26b5ec988eef5a8c439407e42ffaabad99cd7c09b221c3d9729
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-macosx_10_12_x86_64.whl

Download URL ferogram-0.5.5b5-cp310-abi3-macosx_10_12_x86_64.whl
Size 3.8 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
42c97402347f67f490c03bcab9462183315949292a6c9ab3d312441ea341792e
BLAKE2b-256 checksum
How to use checksums
996e16381d2d7c9a338ef8aebd15fd9bb630bed2d840309b7b72a6d737dcd8d2
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-android_24_x86_64.whl

Download URL ferogram-0.5.5b5-cp310-abi3-android_24_x86_64.whl
Size 3.9 MB
Tags Android API level 24+ x86-64 CPython 3.10 abi3
SHA-256 checksum
How to use checksums
d73e1c3cfb4e89cb151c682c7f33cf5eefce9c8b49c02dbf87e0f461db1ea3d0
BLAKE2b-256 checksum
How to use checksums
86c1eb52c5e7121d04fee8bba5e71bd90acb3c926b0abb7c7829e7cd66575f81
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-android_24_x86.whl

Download URL ferogram-0.5.5b5-cp310-abi3-android_24_x86.whl
Size 3.9 MB
Tags Android API level 24+ x86-32 CPython 3.10 abi3
SHA-256 checksum
How to use checksums
94e2dc2bc9a8643b88314dee416ff8fe732b2f4a78f83c32de4ebd89040b0cf7
BLAKE2b-256 checksum
How to use checksums
5b90ea4e8870aa988fd1cc500bb4d54ac0d061574e597891824e8aebd8184f32
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-android_24_armeabi_v7a.whl

Download URL ferogram-0.5.5b5-cp310-abi3-android_24_armeabi_v7a.whl
Size 3.5 MB
Tags Android API level 24+ ARM EABI v7a CPython 3.10 abi3
SHA-256 checksum
How to use checksums
39b39e01c5c113b0e91bfc234707b70619fbc0ffefea6c123727852ed8757729
BLAKE2b-256 checksum
How to use checksums
066af991fa8c17b95f35e07899984ccd446658911485d006f1dc1d3c387c9d40
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 21, 2026.

Transparency log

Release files / ferogram-0.5.5b5-cp310-abi3-android_24_arm64_v8a.whl

Download URL ferogram-0.5.5b5-cp310-abi3-android_24_arm64_v8a.whl
Size 3.7 MB
Tags Android API level 24+ ARM64 v8a CPython 3.10 abi3
SHA-256 checksum
How to use checksums
661d09d4e44476949b8a6dda8595e49c33ac4d65718ad58339ced7c37335870a
BLAKE2b-256 checksum
How to use checksums
9f4181c60010d0a9c9d0e6c4883220889aabb61121b3f5cb25e0e4c4632d0176
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 21, 2026.

Transparency log

Security for ferogram 0.5.5b5

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.5b5.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 21, 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