Skip to main content

Django app to write Telegram bots

Project description

CI:

https://travis-ci.org/jlmadurga/django-telegram-bot.svg?branch=master https://coveralls.io/repos/github/jlmadurga/django-telegram-bot/badge.svg?branch=master Requirements Status

PyPI:

https://img.shields.io/pypi/v/django-telegram-bot.svg

Docs:

Documentation Status

Django app to write Telegram bots. Just define commands and how to handle them.

NOTE: Just for text messages at this moment.

Documentation

The full documentation is at https://django-telegram-bot.readthedocs.org.

Telegram API documentation at https://core.telegram.org/bots/api

Quickstart

Install django-telegram-bot:

pip install django-telegram-bot

Add telegrambot and rest_framework to your INSTALLED_APPS, and run:

$ python manage.py migrate

After creating a bot in Telegram Platform set token received:

TELEGRAM_BOT_TOKEN = "token from your telegram bot"

Add webhook url to your urlpatterns:

url(r'^telegrambot/', include('telegrambot.urls', namespace="telegrambot")

Define whe file where commands will be defined in bothandlers variable, analogue to django urls and ROOT_URLCONF:

TELEGRAM_BOT_HANDLERS_CONF = "app.handlers"

Set bot commands handlers is very easy just as defining urls in django. Module with bothandlers that list different handlers:

bothandlers = [command('start', StartView.as_command_view()),
           command('author', AuthorCommandView.as_command_view()),
           command('author_inverse', AuthorInverseListView.as_command_view()),
           command('author_query', AuthorCommandQueryView.as_command_view()),
           unknown_command(UnknownView.as_command_view()),
           regex(r'author_(?P<name>\w+)', AuthorName.as_command_view()),
          ]

Use command set_webhook to specify the url to receive the incoming updates via webhook:

$ python manage.py set_webhook

To set the webhook for telegram you need django.contrib.sites installed, SITE_ID configured in settings and with it correct value in the DB.

Command views responses with Telegram messages to the user who send the command with a text message and keyboard. Compound with a context and a template. The way it is handled is analogue to Django views. Visits docs for more details https://django-telegram-bot.readthedocs.org/usage.html

Features

  • Commands handling definition.
  • Text responses and keyboards.
  • Media messages not supported.
  • Only Markup parse mode.
https://raw.github.com/jlmadurga/django-oscar-telegram-bot/master/docs/imgs/list_commands.png https://raw.github.com/jlmadurga/django-oscar-telegram-bot/master/docs/imgs/categories.png

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements/test.txt
(myenv) $ make test
(myenv) $ make test-all

History

0.1.0 (2016-21-01)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-telegram-bot, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size django_telegram_bot-0.2.0-py2.py3-none-any.whl (16.4 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size django-telegram-bot-0.2.0.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page