.. image:: https://requires.io/github/jlmadurga/permabots/requirements.svg?branch=master :target: https://requires.io/github/jlmadurga/permabots/requirements/?branch=master :alt: Requirements Status
.. image:: https://readthedocs.org/projects/permabots/badge/?version=latest :target: https://readthedocs.org/projects/permabots/?badge=latest :alt: Documentation Status
Build chat bots and connect then to your app APIs.
With Permabots you can build chat bots and with the same configuration use it for several instant messaging providers. Permabots was born to be a microservice to connect messaging providers to your apps using REST APIs.
The full documentation is at https://permabots.readthedocs.org.
pip install permabots
permabots to your
INSTALLED_APPS, and run::
python manage.py migrate permabots
Instant messaging providers uses webhooks to send messages to your bots. Add permabots processing urls to your urlpatterns::
url(r'^processing/', include('permabots.urls_processing', namespace="permabots"))
Webhooks are generated with
django.contrib.sites. You need it installed and
SITE_ID configured. If you want to generate webhook manually you can do it::
MICROBOT_WEBHOOK_DOMAIN = 'https://yourdomain.herokuapp.com'
It is usefull when you don't have
https in your public domain but you have it in your autogenerated domain. i.e. heroku.
Bots are associated to Django Users. You need at least one user, for example admin user.
Then you can create all permabots data, Bots, Conversation Handlers, Notitication Hooks,... via Django admin or with REST API (recommended).
You can check and deploy a Permabots demo https://github.com/jlmadurga/permabots-demo
Does the code actually work?
source <YOURVIRTUALENV>/bin/activate (myenv) $ pip install -r requirements/test.txt (myenv) $ make test (myenv) $ make test-all