Metadata-Version: 1.1
Name: django-telegram-bot
Version: 0.2.0
Summary: Django app to write Telegram bots
Home-page: https://github.com/jlmadurga/django-telegram-bot
Author: Juan Madurga
Author-email: jlmadurga@gmail.com
License: BSD
Description: =============================
        django-telegram-bot
        =============================
        CI:
        
        .. image:: https://travis-ci.org/jlmadurga/django-telegram-bot.svg?branch=master
            :target: https://travis-ci.org/jlmadurga/django-telegram-bot
        
        .. image:: https://coveralls.io/repos/github/jlmadurga/django-telegram-bot/badge.svg?branch=master 
        	:target: https://coveralls.io/github/jlmadurga/django-telegram-bot?branch=master
          
        .. image:: https://requires.io/github/jlmadurga/django-telegram-bot/requirements.svg?branch=master
             :target: https://requires.io/github/jlmadurga/django-telegram-bot/requirements/?branch=master
             :alt: Requirements Status
             
        PyPI:
        
        
        .. image:: https://img.shields.io/pypi/v/django-telegram-bot.svg
                :target: https://pypi.python.org/pypi/django-telegram-bot
        
        Docs:
        
        .. image:: https://readthedocs.org/projects/django-telegram-bot/badge/?version=latest
                :target: https://readthedocs.org/projects/django-telegram-bot/?badge=latest
                :alt: 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.
        
        .. image:: https://raw.github.com/jlmadurga/django-oscar-telegram-bot/master/docs/imgs/list_commands.png
        
        .. image:: 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.
        
Keywords: django-telegram-bot
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
