.. _telethon_projects:

=======================
Projects using Telethon
=======================

This page lists some real world examples showcasing what can be built with
the library.

.. note::

    Do you have a project that uses the library or know of any that's not
    listed here? Feel free to leave a comment at
    `issue 744 <https://github.com/LonamiWebs/Telethon/issues/744>`_
    so it can be included in the next revision of the documentation!

.. _projects-telegram-export:

telethon_examples/
==================

`telethon_examples <https://github.com/LonamiWebs/Telethon/tree/master/telethon_examples>`_ /
`LonamiWebs' site <https://lonamiwebs.github.io>`_

This documentation is not the only place where you can find useful code
snippets using the library. The main repository also has a folder with
some cool examples (even a Tkinter GUI!) which you can download, edit
and run to learn and play with them.

@TelethonSnippets
=================

`@TelethonSnippets <https://t.me/TelethonSnippets>`_

You can find useful short snippets for Telethon here.

telegram-export
===============

`telegram-export <https://github.com/expectocode/telegram-export>`_ /
`expectocode's GitHub <https://github.com/expectocode>`_

A tool to download Telegram data (users, chats, messages, and media)
into a database (and display the saved data).

.. _projects-mautrix-telegram:

mautrix-telegram
================

`mautrix-telegram <https://github.com/tulir/mautrix-telegram>`_ /
`maunium's site <https://maunium.net/>`_

A Matrix-Telegram hybrid puppeting/relaybot bridge.

.. _projects-telegramtui:

TelegramTUI
===========

`TelegramTUI <https://github.com/bad-day/TelegramTUI>`_ /
`bad-day's GitHub <https://github.com/bad-day>`_

A Telegram client on your terminal.

spotify_telegram_bio_updater
============================

`spotify_telegram_bio_updater <https://github.com/Poolitzer/spotify_telegram_bio_updater>`_ /
`pooltalks' Telegram <https://t.me/pooltalks>`_

Small project that updates the biography of a telegram user according
to their current Spotify playback, or revert it if no playback is active.

Telegram-UserBot
================

`Telegram-UserBot <https://github.com/raphielgang/telegram-userbot>`_ /
`baalajimaestro's site <https://baalajimaestro.ooo>`_

A modular telegram Python UserBot running on python3 with an sqlalchemy database.

kantek
======

`kantek <https://github.com/mojurasu/kantek>`_ /
`mojurasu's site <https://mojurasu.com>`_

kantek is a userbot written in Python using Telethon.

tgcloud
=======

`tgcloud <https://github.com/SlavikMIPT/tgcloud>`_ /
`tgcloud's site <https://dev.tgcloud.xyz/>`_

Opensource Telegram based cloud storage.

tgmount
=======

`tgmount <https://github.com/nktknshn/tgmount>`_ /
`nktknshn's GitHub <https://github.com/nktknshn>`_

Mount Telegram dialogs and channels as a Virtual File System.