Examples
========

This page contains example scripts to show you how Pyrogram looks like.

Every script is working right away (provided you correctly set up your credentials), meaning you can simply copy-paste
and run. The only things you have to change are session names and target chats, where applicable.

The examples listed below can be treated as building blocks for your own applications and are meant to be simple enough
to give you a basic idea.

-----

.. csv-table::
    :header: Example, Description
    :widths: auto
    :align: center

    :doc:`hello_world`, "Demonstration of basic API usage"
    :doc:`echo_bot`, "Echo every private text message"
    :doc:`welcome_bot`, "The Welcome Bot in @PyrogramChat"
    :doc:`get_chat_history`, "Get the full message history of a chat"
    :doc:`get_chat_members`, "Get all the members of a chat"
    :doc:`get_dialogs`, "Get all of your dialog chats"
    :doc:`callback_queries`, "Handle callback queries (as bot) coming from inline button presses"
    :doc:`inline_queries`, "Handle inline queries (as bot) and answer with results"
    :doc:`use_inline_bots`, "Query an inline bot (as user) and send a result to a chat"
    :doc:`bot_keyboards`, "Send normal and inline keyboards using regular bots"
    :doc:`raw_updates`, "Handle raw updates (old, should be avoided)"

For more advanced examples, see https://snippets.pyrogram.org.

.. toctree::
    :hidden:

    hello_world
    echo_bot
    welcome_bot
    get_chat_history
    get_chat_members
    get_dialogs
    callback_queries
    inline_queries
    use_inline_bots
    bot_keyboards
    raw_updates