Quickstart

Ping Pong Bot

Starting project

Once Bottery is installed, you will be able to use the Bottery cli (command-line interface). For starting a new project, run:

$ bottery startproject librarybot

This will create a directory named librarybot in your current directory with files inside:

librarybot/
    bot.py
    settings.py
  • The outer librarybot/ root directory is just a container for your project. Its name doesn’t matter to Bottery, you can rename it to anything you like.
  • librarybot/bot.py: Where we define which messages we are able to receive and how to responde them;
  • librarybot/settings.py: Settings/configuration for this Bottery project.

Keep in mind that the name you’ll choose for your project must be a valid identifier according to the language definition (check the documentation for further information on identifiers).

Configuring token

For this example we will use Telegram Bot platform. The only thing you need to configure is the bot token on settings.py file. This token is generated when you create your bot on Telegram. For more info, check out how to create a new bot in the Telegram documentation.

When you have the token, put it on Telegram platform configurations:

PLATFORMS = {
    'telegram': {
        'ENGINE': 'bottery.platform.telegram',
        'OPTIONS': {
            'token': 'the-bot-token-here',
        }
    },
}

Running

To run your bot just type:

$ bottery run

That’s it, there’s nothing else to do. Your bot should be working now. Go to Telegram and type ping to your bot, it should respond with pong.

Project Examples

A small example of how bottery can work can be seen here.