{"id":23311911,"url":"https://github.com/jlmadurga/permabots","last_synced_at":"2025-08-22T13:30:54.071Z","repository":{"id":5566263,"uuid":"53449230","full_name":"jlmadurga/permabots","owner":"jlmadurga","description":"Connect instant messaging bots to your APIs. ","archived":false,"fork":false,"pushed_at":"2022-12-26T20:30:20.000Z","size":2686,"stargazers_count":82,"open_issues_count":16,"forks_count":24,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-19T20:39:40.110Z","etag":null,"topics":["bots","chatbot","django","facebook-messenger-bot","kikbot","python","telegram"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlmadurga.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-08T22:15:49.000Z","updated_at":"2024-11-26T12:32:46.000Z","dependencies_parsed_at":"2023-01-13T13:36:15.259Z","dependency_job_id":null,"html_url":"https://github.com/jlmadurga/permabots","commit_stats":null,"previous_names":["jlmadurga/microbot"],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlmadurga%2Fpermabots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlmadurga%2Fpermabots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlmadurga%2Fpermabots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlmadurga%2Fpermabots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlmadurga","download_url":"https://codeload.github.com/jlmadurga/permabots/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230596266,"owners_count":18250855,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bots","chatbot","django","facebook-messenger-bot","kikbot","python","telegram"],"created_at":"2024-12-20T14:17:16.019Z","updated_at":"2024-12-20T14:17:16.527Z","avatar_url":"https://github.com/jlmadurga.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=============================\nPermabots\n=============================\n\n.. image:: https://github.com/jlmadurga/permabots/raw/master/docs/images/logos/permabots.png\n    :target: https://github.com/jlmadurga/permabots\n\n\nCI:\n\n.. image:: https://travis-ci.org/jlmadurga/permabots.svg?branch=master\n    :target: https://travis-ci.org/jlmadurga/permabots\n\n.. image:: https://coveralls.io/repos/github/jlmadurga/permabots/badge.svg?branch=master \n\t:target: https://coveralls.io/github/jlmadurga/permabots?branch=master\n  \n.. image:: https://requires.io/github/jlmadurga/permabots/requirements.svg?branch=master\n     :target: https://requires.io/github/jlmadurga/permabots/requirements/?branch=master\n     :alt: Requirements Status\n     \nPyPI:\n\n\n.. image:: https://img.shields.io/pypi/v/permabots.svg\n        :target: https://pypi.python.org/pypi/permabots\n\nDocs:\n\n.. image:: https://readthedocs.org/projects/permabots/badge/?version=latest\n        :target: https://readthedocs.org/projects/permabots/?badge=latest\n        :alt: Documentation Status\n\n\nBuild chat bots and connect then to your app APIs. \n\nWith Permabots you can build chat bots and with the same configuration use it for several instant messaging providers. Permabots\nwas born to be a microservice to connect messaging providers to your apps using REST APIs.\n\n.. image:: https://github.com/jlmadurga/permabots/raw/master/docs/images/demo.gif\n    :target: https://github.com/jlmadurga/permabots\n\n\nDocumentation\n-------------\n\nThe full documentation is at https://permabots.readthedocs.org.\n\n\nFeatures\n--------\n\n* Telegram, Kik and Facebook Messenger bots\n* Message handling definition with regex, as django urls.\n* HTTP methods: GET/POST/PUT/DELETE/PATCH\n* Text responses and keyboards with Jinja2 templates\n* Chat State handling\n* Asynchronous processing of messages\n* Media messages not supported\n\nQuickstart\n----------\n\n\nInstall permabots::\n\n    pip install permabots\n    \nAdd ``permabots`` to your ``INSTALLED_APPS``, and run::\n\n\t$ python manage.py migrate permabots\n\t\nInstant messaging providers uses webhooks to send messages to your bots. Add permabots processing urls to your urlpatterns::\n\n\turl(r'^processing/', include('permabots.urls_processing', namespace=\"permabots\"))\n\t\nWebhooks 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::\n\n\tMICROBOT_WEBHOOK_DOMAIN = 'https://yourdomain.herokuapp.com' \n\nIt is usefull when you don't have ``https`` in your public domain but you have it in your autogenerated domain. i.e. heroku.\n\t\nBots are associated to Django Users. You need at least one user, for example admin user.\n\nThen you can create all permabots data, Bots, Conversation Handlers, Notitication Hooks,... via Django admin or with REST API (recommended).\n\nDemo\n--------------\n\nYou can check and deploy a Permabots demo https://github.com/jlmadurga/permabots-demo\n\n.. image:: https://www.herokucdn.com/deploy/button.svg\n    :target: https://heroku.com/deploy?template=https://github.com/jlmadurga/permabots-demo/tree/master\n\nRunning Tests\n--------------\n\nDoes the code actually work?\n\n::\n\n    source \u003cYOURVIRTUALENV\u003e/bin/activate\n    (myenv) $ pip install -r requirements/test.txt\n    (myenv) $ make test\n    (myenv) $ make test-all\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlmadurga%2Fpermabots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlmadurga%2Fpermabots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlmadurga%2Fpermabots/lists"}