Welcome to django-oscar-telegram-bot’s documentation!¶

Documentation¶

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

This package uses django-telegram-bot, take a look to https://github.com/jlmadurga/django-telegram-bot

Quickstart¶

Install django-oscar-telegram-bot:

pip install django-oscar-telegram-bot

Add it to your INSTALLED_APPS:

INSTALLED_APPS = [
        ...
        'oscar_telegrambot', # this app
        'telegrambot', #  django-telegram-bot
        'rest_framework', # django-telegram-bot uses django-rest-framework
        ...
]

Configure in settings:

TELEGRAM_BOT_COMMANDS_CONF = "oscar_telegrambot.commands"

As other django-telegram-bot app set your Bots with admin panel.

Add url to have webhook:

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

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.

You can take a look to a demo repo using the sandbox in https://github.com/jlmadurga/django-oscar-telegram-bot-demo. This demo is already installed in http://django-oscar-telegram-bot-demo.herokuapp.com/en-gb/ and you can test the bot https://telegram.me/djangooscartelegrambotdemo_bot

Features¶

• Wellcome and help commands
• Unknown command handler
• Categories list command
• Products list command
• Product detail command
• Order list&detail command only when logged

Running Tests¶

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py

Screenshots from demo¶

Wellcome:

List of commands:

List of categories and keyboard to select the category:

Products of a category. Select the product in keyboard:

Product detail:

Order detail providing order number:

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up django-oscar-telegram-bot for local development.

1. Fork the django-oscar-telegram-bot repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/django-oscar-telegram-bot.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv django-oscar-telegram-bot
   $ cd django-oscar-telegram-bot/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ flake8 oscar_telegrambot tests
$ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/jlmadurga/django-oscar-telegram-bot/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_telegram_bot

Development Lead¶

• Juan Madurga <jlmadurga@gmail.com>

Contributors¶

None yet. Why not be the first?

0.1.0 (2016-01-26)¶

• First release on PyPI.