Quick Start
Python 3.10+ required. Install using pipx:
pipx install tgpy
tgpy
or Docker:
docker pull tgpy/tgpy
docker run -it --rm -v /tgpy_data:/data tgpy/tgpy
Then follow instructions to connect your Telegram account.
More on installation: https://tgpy.dev/installation
Next, learn TGPy basics: https://tgpy.dev/basics
Use Cases
Here are a few examples of how people use TGPy:
🧮 Run Python as an in-chat calculator
🔍 Search for song lyrics within a chat
🧹 Delete multiple messages with a command
📊 Find out the most active members in a chat
✏️ Instantly convert TeX to Unicode in messages:
For example, x = \alpha^7 becomes x = α⁷
About
TGPy allows you to easily write and execute code snippets directly within your Telegram messages. Combine Telegram features with the full power of Python: Integrate with libraries and APIs. Create functions and TGPy modules to reuse code in the future. Set up code transformers and hooks to create custom commands and tweak Python syntax.
TGPy uses Telegram API through the Telethon library.
Inspiration and Credits
TGPy is inspired by FTG and similar userbots. However, the key concept is different: TGPy is totally based on usage of code in Telegram rather than plugging extra modules. It was designed for running single-use scripts and reusing code flexibly. You can think of TGPy as **a userbot for programmers **.
We built TGPy with Telethon, a Python library to interact with Telegram API. Basic code transformation (such as auto-return of values) is based on meval.
TGPy Docs use Material for MKDocs with custom CSS.
License
This project is licensed under the terms of the MIT license.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tgpy-0.22.1.tar.gz.
File metadata
- Download URL: tgpy-0.22.1.tar.gz
- Upload date:
- Size: 25.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
24d07558bacbcaee6115b462818551e3e7ecc01adb326378e7e564cc55a480f5
|
|
| MD5 |
a5560f59713a31f4d440bada7658442b
|
|
| BLAKE2b-256 |
8205a2301e6a41f12903fecc57f3edd51bffcc6dc73a8d54399300ff0c63a948
|
Provenance
The following attestation bundles were made for tgpy-0.22.1.tar.gz:
Publisher:
main.yml on tm-a-t/TGPy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tgpy-0.22.1.tar.gz -
Subject digest:
24d07558bacbcaee6115b462818551e3e7ecc01adb326378e7e564cc55a480f5 - Sigstore transparency entry: 2192274309
- Sigstore integration time:
-
Permalink:
tm-a-t/TGPy@c47645d713a43c6e85745a278eb267a2b70a0036 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/tm-a-t
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
main.yml@c47645d713a43c6e85745a278eb267a2b70a0036 -
Trigger Event:
push
-
Statement type:
File details
Details for the file tgpy-0.22.1-py3-none-any.whl.
File metadata
- Download URL: tgpy-0.22.1-py3-none-any.whl
- Upload date:
- Size: 33.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
454956dba9e24da321e2c6f243ca21a039f1ab2cacd636abfdeb41095f1506f1
|
|
| MD5 |
08892da15647d1cb5a8c7e59160924a3
|
|
| BLAKE2b-256 |
93a14fd9279c1fe59fca913c37276b89854299387bd255a98dda8ccec0f27345
|
Provenance
The following attestation bundles were made for tgpy-0.22.1-py3-none-any.whl:
Publisher:
main.yml on tm-a-t/TGPy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tgpy-0.22.1-py3-none-any.whl -
Subject digest:
454956dba9e24da321e2c6f243ca21a039f1ab2cacd636abfdeb41095f1506f1 - Sigstore transparency entry: 2192274388
- Sigstore integration time:
-
Permalink:
tm-a-t/TGPy@c47645d713a43c6e85745a278eb267a2b70a0036 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/tm-a-t
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
main.yml@c47645d713a43c6e85745a278eb267a2b70a0036 -
Trigger Event:
push
-
Statement type:
