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

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

Built distributions (wheels)

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

Total release size: 34.2 MB

Release files / ferogram-0.5.5b4.tar.gz

Download URL ferogram-0.5.5b4.tar.gz
Size 739.4 kB
Tags Source
SHA-256 checksum
How to use checksums
376e6c4a9f2e2abe8e8ae9fe2eaf321b98045a964b28f464cd237e6f3a406843
BLAKE2b-256 checksum
How to use checksums
125800f3262638c7bed496f93ecfee058ee71eb261a1f2d19b4a88c066be31ee
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.5b4-cp39-abi3-win_amd64.whl

Download URL ferogram-0.5.5b4-cp39-abi3-win_amd64.whl
Size 4.0 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
9da3b914a99c413b35dbc9775f5e8e24ae3501a1c369c54e8389c7db22fc9670
BLAKE2b-256 checksum
How to use checksums
beb15091b93761d6771b4657073c79108b2b6e32dce8cdf2ef64870fc94c2580
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.5b4-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL ferogram-0.5.5b4-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
1f5cda24f351799ad9d51b5c0a8439428b2687a1eb229bd8abb23f113634e7e9
BLAKE2b-256 checksum
How to use checksums
292a4c1d357dead6f72cff513199c74d25edd29517568b10e1cb1078864bd923
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.5b4-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL ferogram-0.5.5b4-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
274bbb88305d0356fa97d06cb570fd24e37e7a2611c2b33a08a5c87d7ede9ad5
BLAKE2b-256 checksum
How to use checksums
adbade4b823c75c2d02e03927e1d2b09c34521d0c4d728fc3a17b290e379ad2a
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.5b4-cp39-abi3-macosx_11_0_arm64.whl

Download URL ferogram-0.5.5b4-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
49acaadcfc667e976a4368b417ea432ae388c5cd0a58bf0fef1d1c2394371db8
BLAKE2b-256 checksum
How to use checksums
adc0e236796cbbd0bcfc0cf8b83148c2f8f7dbb08462bba1a95ad4b00c969c60
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.5b4-cp39-abi3-macosx_10_12_x86_64.whl

Download URL ferogram-0.5.5b4-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
b570ce3ec1d6fbe09e9c5a3a14a6ebe6b9b4c0b3b3478c8c1ddefb3104d74670
BLAKE2b-256 checksum
How to use checksums
084e794242c5af16d63e5555cbc76e99056abf10509c5a1e03533a379c60223b
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.5b4-cp39-abi3-android_24_x86_64.whl

Download URL ferogram-0.5.5b4-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
058e61952fcc8349cff1abd23eb4064e282c308ea02c5016649585d11ea5551e
BLAKE2b-256 checksum
How to use checksums
c94e824f1198d129f278398c40245fa548f16cae86539bfd3e0395d19af4edf8
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.5b4-cp39-abi3-android_24_x86.whl

Download URL ferogram-0.5.5b4-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
0b79fcb16516d50e5f57a783844471f93b5c81716f847c66448b7c0541ea11f1
BLAKE2b-256 checksum
How to use checksums
8411dee05ff4a1bf55ccf0c9020c5efb4e3ebb3c691903fcf420282083df8955
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.5b4-cp39-abi3-android_24_armeabi_v7a.whl

Download URL ferogram-0.5.5b4-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
3c97111e44d74252cee21964fe4ae5ffcba19688e70fddbe03c8e95a19eb61ac
BLAKE2b-256 checksum
How to use checksums
66b145de249cc946083f0c8be3d33014ddaf71ae03ac92380dbf0216aa5681a6
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.5b4-cp39-abi3-android_24_arm64_v8a.whl

Download URL ferogram-0.5.5b4-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
136820bfa293396461a73b3cacce8b4d7538f3da605b9a57e08dd8a503fb8750
BLAKE2b-256 checksum
How to use checksums
950b9d674a8dc6ef5804a99bd241e86a55a8b8c99a14ea5adbc88bca66a85979
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.5b4

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