.. _telethon_projects:

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

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

.. note::

    Do you have an interesting 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!

    You can also advertise your bot and its features, in the issue, although
    it should be a big project which can be useful for others before being
    included here, so please don't feel offended if it can't be here!


.. _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.

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.

garnet
======

`garnet <https://github.com/uwinx/pomegranate>`_ /
`uwinx's GitHub <https://github.com/uwinx>`_

Pomegranate (or ``garnet`` for short) is a small telethon add-on which
features persistent conversations based on Finite State Machines (FSM),
a new ``Filter`` to define handlers more conveniently and utilities to
run code on start and finish of the client. Be sure to check the project
to learn about its latest features, since this description may be out of
date.