python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-08 17:13:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Rewrite quick start guide.

Browse source
This commit is contained in:
Alex Root Junior 2017-11-16 19:37:52 +02:00
parent 3a5c2d78f3
commit 7025542e3c
2 changed files with 30 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/bot/base.rst
View file

@ -1,7 +1,7 @@
BaseBot BaseBot
======= =======
This class is base of bot. In BaseBot implemented all available methods of Telegram Bot API. This class is base of bot. In BaseBot implemented only methods for interactions with Telegram Bot API.
.. autoclass:: aiogram.bot.base.BaseBot .. autoclass:: aiogram.bot.base.BaseBot
:members: :members:

70
docs/source/quick_start.rst
View file

@ -4,62 +4,50 @@ Quick start
Simple template Simple template
--------------- ---------------
.. code-block:: python3 By first step you need import all modules
import asyncio
from aiogram import Bot
loop = asyncio.get_event_loop()
bot = Bot('TOKEN', loop)
async def main():
bot_info = await bot.get_me()
print(bot_info.username)
if __name__ == '__main__':
try:
loop.run_until_complete(main())
except KeyboardInterrupt:
loop.stop()
Manual
------
First you need to get event loop from asyncio
.. code-block:: python3 .. code-block:: python3
import asyncio from aiogram import Bot
from aiogram.dispatcher import Dispatcher
from aiogram.utils import executor
loop = asyncio.get_event_loop() In next step you you can initialize bot and dispatcher instances.
Bot token you can get from `@BotFather <https://t.me/BotFather>`_
Then create bot instance, if you have bot token.
Token you can get from `@BotFather <https://t.me/BotFather>`_
.. code-block:: python3 .. code-block:: python3
from aiogram import Bot bot = Bot(token='BOT TOKEN HERE')
dp = Dispatcher(bot)
bot = Bot('TOKEN', loop) And next: all bots is needed command for starting interaction with bot. Register first command handler:
And then you can use Dispather module:
.. code-block:: python3 .. code-block:: python3
from aiogram.dispather import Dispatcher @dp.message_handler(commands=['start', 'help'])
async def send_welcome(message: types.Message):
await message.reply("Hi!\nI'm EchoBot!\nPowered by aiogram.")
dp = Dispatcher(bot) And last step - run long pooling.
Dispatcher cah handler updates from telegram bot API. .. code-block:: python3
It have **dp.start_pooling()** method. if __name__ == '__main__':
executor.start_pooling(dp, on_startup=startup)
Summary
-------
.. code-block:: python3
from aiogram import Bot
from aiogram.dispatcher import Dispatcher
from aiogram.utils import executor
bot = Bot(token='BOT TOKEN HERE')
dp = Dispatcher(bot)
if __name__ == '__main__':
executor.start_pooling(dp)