.. image:: https://errbot.readthedocs.org/en/latest/_static/errbot.png
:target: http://errbot.io
|
.. image:: https://github.com/errbotio/errbot/workflows/Python%20package/badge.svg
:target: https://github.com/errbotio/errbot/actions
.. image:: https://img.shields.io/pypi/v/errbot.svg
:target: https://pypi.python.org/pypi/errbot
:alt: Latest Version
.. image:: https://img.shields.io/badge/License-GPLv3-green.svg
:target: https://pypi.python.org/pypi/errbot
:alt: License
.. image:: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg
:target: https://gitter.im/errbotio/errbot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
:alt: Join the chat at https://gitter.im/errbotio/errbot
|
Note: This is a forked version of Errbot. The main reason was, to be able to have an automated release process and release the
changes often. The base for this fork was version 6.1.9 (commit: 7609f6c) from June 2023. The first released version here is
7.0.0 and contains all unreleased changes up to commit 0080eff1324930207f021f55674d5240abae172d from 2023-10-30.
- Docker image: `ghcr.io/hapag-lloyd/errbot-hl <https://github.com/Hapag-Lloyd/errbot/pkgs/container/errbot>`__
- PyPi package: `errbot-hl <https://pypi.org/project/errbot-hl/>`__
Errbot
======
Errbot is a chatbot. It allows you to start scripts interactively from your chatrooms
for any reason: random humour, chatops, starting a build, monitoring commits, triggering
alerts...
It is written and easily extensible in Python.
Errbot is available as open-source software and released under the GPL v3 license.
Features
--------
Chat servers support
~~~~~~~~~~~~~~~~~~~~
**Built-in**
- IRC support
- `Telegram support <https://www.telegram.org/>`_
- `XMPP support <http://xmpp.org>`_
**With add-ons**
- `Slack support <https://slack.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-slackv3>`__)
- `Discord <https://www.discordapp.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-discord>`__)
- `Gitter support <https://gitter.im/>`_ (See `instructions <https://github.com/errbotio/err-backend-gitter>`__)
- `Webex <https://www.webex.com/>`_ (See `instructions <https://github.com/marksull/err-backend-cisco-webex-teams>`__)
- `Mattermost <https://about.mattermost.com/>`_ (See `instructions <https://github.com/Vaelor/errbot-mattermost-backend>`__)
- `RocketChat <https://rocket.chat/>`_ (See `instructions <https://github.com/cardoso/errbot-rocketchat>`__)
- `Skype <https://www.skype.com/>`_ (See `instructions <https://github.com/errbotio/errbot-backend-skype>`__)
- `TOX <https://tox.im/>`_ (See `instructions <https://github.com/errbotio/err-backend-tox>`__)
- `VK <https://vk.com/>`_ (See `instructions <https://github.com/Ax3Effect/errbot-vk>`__)
- `Zulip <https://zulipchat.com/>`_ (See `instructions <https://github.com/zulip/errbot-backend-zulip>`__)
Administration
~~~~~~~~~~~~~~
After the initial installation and security setup, Errbot can be administered by just chatting to the bot (chatops).
- install/uninstall/update/enable/disable private or public plugins hosted on git
- plugins can be configured from chat
- direct the bot to join/leave Multi User Chatrooms (MUC)
- Security: ACL control feature (admin/user rights per command)
- backup: an integrated command !backup creates a full export of persisted data.
- logs: can be inspected from chat or streamed to Sentry.
Developer features
~~~~~~~~~~~~~~~~~~
- Very easy to extend in Python! (see below)
- Presetup storage for every plugin i.e. ``self['foo'] = 'bar'`` persists the value.
- Conversation flows to track conversation states from users.
- Webhook callbacks support
- supports `markdown extras <https://markdown-extra.readthedocs.io/>`_ formatting with tables, embedded images, links etc.
- configuration helper to allow your plugin to be configured by chat
- Text development/debug consoles
- Self-documenting: your docstrings become help automatically
- subcommands and various arg parsing options are available (re, command line type)
- polling support: your can setup a plugin to periodically do something
- end to end test backend
- card rendering under Slack
Community and support
---------------------
If you have:
- a quick question feel free to join us on chat at `errbotio/errbot on Gitter <https://gitter.im/errbotio/errbot>`_.
- a plugin development question please use `Stackoverflow <http://stackoverflow.com/questions/tagged/errbot>`_ with the tags `errbot` and `python`.
- a bug to report or a feature request, please use our `GitHub project page <https://github.com/errbotio/errbot/issues>`_.
You can also ping us on Twitter with the hashtag ``#errbot``.
Installation
------------
Prerequisites
~~~~~~~~~~~~~
Errbot runs under Python 3.6+ on Linux, Windows and Mac. For some chatting systems you'll need a key or a login for your bot to access it.
Quickstart
~~~~~~~~~~
We recommend to setup a `virtualenv <https://pypi.python.org/pypi/virtualenv>`_.
1. Install `errbot` from pip
2. Make a directory somewhere (here called `errbot`) to host Errbot's data files
3. Initialize the directory
4. Try out Errbot in text mode
.. code:: bash
$ pip install errbot
$ mkdir errbot; cd errbot
$ errbot --init
$ errbot
It will show you a prompt `>>>` so you can talk to your bot directly! Try `!help` to get started.
Adding support for a chat system
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For the built-ins, just use one of those options `telegram, IRC, XMPP` with pip, you can still do it
after the initial installation to add the missing support for example ::
$ pip install "errbot[irc]"
For the external ones (Slack, Discord, Gitter, Skype, etc ...), please follow their respective github pages for instructions.
Configuration
~~~~~~~~~~~~~
In order to configure Errbot to connect to one of those chat systems you'll need to tweak the `config.py` file generated
by `errbot --init`.
To help you, we have a documented template available here: `config-template.py <https://raw.githubusercontent.com/errbotio/errbot/master/errbot/config-template.py>`_.
Note: even if you changed the BACKEND from the configuration, you can still use `errbot -T` to test
out your instance locally in text mode.
Starting Errbot as a daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~
If all that worked, you can now use the -d (or --daemon) parameter to run it in a
detached mode:
.. code:: bash
errbot --daemon
Interacting with the Bot
------------------------
After starting Errbot, you should add the bot to your buddy list if you haven't already.
You'll need to invite the bot explicitly to chatrooms on some chat systems too.
You can now send commands directly to the bot!
To get a list of all available commands, you can issue:
.. code:: bash
!help
If you just wish to know more about a specific command you can issue:
.. code:: bash
!help command
Managing plugins
~~~~~~~~~~~~~~~~
You can administer the bot in a one-on-one chat if your handle is in the BOT_ADMINS list in `config.py`.
For example to keyword search in the public plugin repos you can issue:
.. code:: bash
!repos search jira
To install a plugin from this list, issue:
.. code:: bash
!repos install <name of repo>
For example `!repos install errbotio/err-imagebot`.
Writing plugins
---------------
Writing your own plugins is extremely simple. `errbot --init` will have installed in the `plugins` subdirectory a plugin
called `err-example` you can use as a base.
As an example, this is all it takes to create a "Hello, world!" plugin for Errbot:
.. code:: python
from errbot import BotPlugin, botcmd
class Hello(BotPlugin):
"""Example 'Hello, world!' plugin for Errbot"""
@botcmd
def hello(self, msg, args):
"""Return the phrase "Hello, world!" to you"""
return "Hello, world!"
This plugin will create the command "!hello" which, when issued, returns "Hello, world!"
to you. For more info on everything you can do with plugins, see the
`plugin development guide <https://errbot.io/en/latest/user_guide/plugin_development/>`_.
Contribution to Errbot itself
-----------------------------
Feel free to fork and propose changes on `github <https://www.github.com/errbotio/errbot>`_
Raw data
{
"_id": null,
"home_page": "http://errbot.io/",
"name": "errbot-hl",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "xmpp irc slack hipchat gitter tox chatbot bot plugin chatops",
"author": "errbot.io",
"author_email": "info@errbot.io",
"download_url": "https://files.pythonhosted.org/packages/28/b6/56ed68dc50ad9c506840ae359915586b66e5b225b0c637dcba70ff2d84dc/errbot-hl-7.0.0.tar.gz",
"platform": "any",
"description": ".. image:: https://errbot.readthedocs.org/en/latest/_static/errbot.png\n :target: http://errbot.io\n\n|\n\n.. image:: https://github.com/errbotio/errbot/workflows/Python%20package/badge.svg\n :target: https://github.com/errbotio/errbot/actions\n\n\n.. image:: https://img.shields.io/pypi/v/errbot.svg\n :target: https://pypi.python.org/pypi/errbot\n :alt: Latest Version\n\n.. image:: https://img.shields.io/badge/License-GPLv3-green.svg\n :target: https://pypi.python.org/pypi/errbot\n :alt: License\n\n.. image:: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg\n :target: https://gitter.im/errbotio/errbot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n :alt: Join the chat at https://gitter.im/errbotio/errbot\n\n|\n\nNote: This is a forked version of Errbot. The main reason was, to be able to have an automated release process and release the\nchanges often. The base for this fork was version 6.1.9 (commit: 7609f6c) from June 2023. The first released version here is\n7.0.0 and contains all unreleased changes up to commit 0080eff1324930207f021f55674d5240abae172d from 2023-10-30.\n\n- Docker image: `ghcr.io/hapag-lloyd/errbot-hl <https://github.com/Hapag-Lloyd/errbot/pkgs/container/errbot>`__\n- PyPi package: `errbot-hl <https://pypi.org/project/errbot-hl/>`__\n\n\nErrbot\n======\n\nErrbot is a chatbot. It allows you to start scripts interactively from your chatrooms\nfor any reason: random humour, chatops, starting a build, monitoring commits, triggering\nalerts...\n\nIt is written and easily extensible in Python.\n\nErrbot is available as open-source software and released under the GPL v3 license.\n\n\nFeatures\n--------\n\nChat servers support\n~~~~~~~~~~~~~~~~~~~~\n\n**Built-in**\n\n- IRC support\n- `Telegram support <https://www.telegram.org/>`_\n- `XMPP support <http://xmpp.org>`_\n\n**With add-ons**\n\n- `Slack support <https://slack.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-slackv3>`__)\n- `Discord <https://www.discordapp.com/>`_ (See `instructions <https://github.com/errbotio/err-backend-discord>`__)\n- `Gitter support <https://gitter.im/>`_ (See `instructions <https://github.com/errbotio/err-backend-gitter>`__)\n- `Webex <https://www.webex.com/>`_ (See `instructions <https://github.com/marksull/err-backend-cisco-webex-teams>`__)\n- `Mattermost <https://about.mattermost.com/>`_ (See `instructions <https://github.com/Vaelor/errbot-mattermost-backend>`__)\n- `RocketChat <https://rocket.chat/>`_ (See `instructions <https://github.com/cardoso/errbot-rocketchat>`__)\n- `Skype <https://www.skype.com/>`_ (See `instructions <https://github.com/errbotio/errbot-backend-skype>`__)\n- `TOX <https://tox.im/>`_ (See `instructions <https://github.com/errbotio/err-backend-tox>`__)\n- `VK <https://vk.com/>`_ (See `instructions <https://github.com/Ax3Effect/errbot-vk>`__)\n- `Zulip <https://zulipchat.com/>`_ (See `instructions <https://github.com/zulip/errbot-backend-zulip>`__)\n\n\nAdministration\n~~~~~~~~~~~~~~\n\nAfter the initial installation and security setup, Errbot can be administered by just chatting to the bot (chatops).\n\n- install/uninstall/update/enable/disable private or public plugins hosted on git\n- plugins can be configured from chat\n- direct the bot to join/leave Multi User Chatrooms (MUC)\n- Security: ACL control feature (admin/user rights per command)\n- backup: an integrated command !backup creates a full export of persisted data.\n- logs: can be inspected from chat or streamed to Sentry.\n\nDeveloper features\n~~~~~~~~~~~~~~~~~~\n\n- Very easy to extend in Python! (see below)\n- Presetup storage for every plugin i.e. ``self['foo'] = 'bar'`` persists the value.\n- Conversation flows to track conversation states from users.\n- Webhook callbacks support\n- supports `markdown extras <https://markdown-extra.readthedocs.io/>`_ formatting with tables, embedded images, links etc.\n- configuration helper to allow your plugin to be configured by chat\n- Text development/debug consoles\n- Self-documenting: your docstrings become help automatically\n- subcommands and various arg parsing options are available (re, command line type)\n- polling support: your can setup a plugin to periodically do something\n- end to end test backend\n- card rendering under Slack\n\nCommunity and support\n---------------------\n\nIf you have:\n\n- a quick question feel free to join us on chat at `errbotio/errbot on Gitter <https://gitter.im/errbotio/errbot>`_.\n- a plugin development question please use `Stackoverflow <http://stackoverflow.com/questions/tagged/errbot>`_ with the tags `errbot` and `python`.\n- a bug to report or a feature request, please use our `GitHub project page <https://github.com/errbotio/errbot/issues>`_.\n\nYou can also ping us on Twitter with the hashtag ``#errbot``.\n\n\nInstallation\n------------\n\nPrerequisites\n~~~~~~~~~~~~~\n\nErrbot runs under Python 3.6+ on Linux, Windows and Mac. For some chatting systems you'll need a key or a login for your bot to access it.\n\nQuickstart\n~~~~~~~~~~\n\nWe recommend to setup a `virtualenv <https://pypi.python.org/pypi/virtualenv>`_.\n\n1. Install `errbot` from pip\n2. Make a directory somewhere (here called `errbot`) to host Errbot's data files\n3. Initialize the directory\n4. Try out Errbot in text mode\n\n.. code:: bash\n\n $ pip install errbot\n $ mkdir errbot; cd errbot\n $ errbot --init\n $ errbot\n\nIt will show you a prompt `>>>` so you can talk to your bot directly! Try `!help` to get started.\n\nAdding support for a chat system\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nFor the built-ins, just use one of those options `telegram, IRC, XMPP` with pip, you can still do it\nafter the initial installation to add the missing support for example ::\n\n $ pip install \"errbot[irc]\"\n\nFor the external ones (Slack, Discord, Gitter, Skype, etc ...), please follow their respective github pages for instructions.\n\nConfiguration\n~~~~~~~~~~~~~\n\nIn order to configure Errbot to connect to one of those chat systems you'll need to tweak the `config.py` file generated\nby `errbot --init`.\n\nTo help you, we have a documented template available here: `config-template.py <https://raw.githubusercontent.com/errbotio/errbot/master/errbot/config-template.py>`_.\n\nNote: even if you changed the BACKEND from the configuration, you can still use `errbot -T` to test\nout your instance locally in text mode.\n\nStarting Errbot as a daemon\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf all that worked, you can now use the -d (or --daemon) parameter to run it in a\ndetached mode:\n\n.. code:: bash\n\n errbot --daemon\n\nInteracting with the Bot\n------------------------\n\nAfter starting Errbot, you should add the bot to your buddy list if you haven't already.\nYou'll need to invite the bot explicitly to chatrooms on some chat systems too.\nYou can now send commands directly to the bot!\n\nTo get a list of all available commands, you can issue:\n\n.. code:: bash\n\n !help\n\nIf you just wish to know more about a specific command you can issue:\n\n.. code:: bash\n\n !help command\n\nManaging plugins\n~~~~~~~~~~~~~~~~\n\nYou can administer the bot in a one-on-one chat if your handle is in the BOT_ADMINS list in `config.py`.\n\nFor example to keyword search in the public plugin repos you can issue:\n\n.. code:: bash\n\n !repos search jira\n\nTo install a plugin from this list, issue:\n\n.. code:: bash\n\n !repos install <name of repo>\n\n\nFor example `!repos install errbotio/err-imagebot`.\n\nWriting plugins\n---------------\n\nWriting your own plugins is extremely simple. `errbot --init` will have installed in the `plugins` subdirectory a plugin\ncalled `err-example` you can use as a base.\n\nAs an example, this is all it takes to create a \"Hello, world!\" plugin for Errbot:\n\n.. code:: python\n\n from errbot import BotPlugin, botcmd\n\n class Hello(BotPlugin):\n \"\"\"Example 'Hello, world!' plugin for Errbot\"\"\"\n\n @botcmd\n def hello(self, msg, args):\n \"\"\"Return the phrase \"Hello, world!\" to you\"\"\"\n return \"Hello, world!\"\n\nThis plugin will create the command \"!hello\" which, when issued, returns \"Hello, world!\"\nto you. For more info on everything you can do with plugins, see the\n`plugin development guide <https://errbot.io/en/latest/user_guide/plugin_development/>`_.\n\nContribution to Errbot itself\n-----------------------------\n\nFeel free to fork and propose changes on `github <https://www.github.com/errbotio/errbot>`_\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Errbot is a chatbot designed to be simple to extend with plugins written in Python.",
"version": "7.0.0",
"project_urls": {
"Homepage": "http://errbot.io/"
},
"split_keywords": [
"xmpp",
"irc",
"slack",
"hipchat",
"gitter",
"tox",
"chatbot",
"bot",
"plugin",
"chatops"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f83ba65fa0f14c0642e89c23346e8ea64d44a29b1a8572142864e40e3bc647b7",
"md5": "66303b0d6e3b37d8d75fda67d43a1f16",
"sha256": "95ae77a3b317fd5d92770c637fb838d5bf3b9f03efee26fa31c4004b49c8ea01"
},
"downloads": -1,
"filename": "errbot_hl-7.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66303b0d6e3b37d8d75fda67d43a1f16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 170579,
"upload_time": "2023-11-18T20:34:11",
"upload_time_iso_8601": "2023-11-18T20:34:11.566596Z",
"url": "https://files.pythonhosted.org/packages/f8/3b/a65fa0f14c0642e89c23346e8ea64d44a29b1a8572142864e40e3bc647b7/errbot_hl-7.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28b656ed68dc50ad9c506840ae359915586b66e5b225b0c637dcba70ff2d84dc",
"md5": "af06f165a51669a4a974b3674705ac27",
"sha256": "121e8c8e64a6f99ece368ce3f1213e0c6975240dfdcc9a7dae5b61cde4e35e8c"
},
"downloads": -1,
"filename": "errbot-hl-7.0.0.tar.gz",
"has_sig": false,
"md5_digest": "af06f165a51669a4a974b3674705ac27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 168348,
"upload_time": "2023-11-18T20:34:13",
"upload_time_iso_8601": "2023-11-18T20:34:13.250163Z",
"url": "https://files.pythonhosted.org/packages/28/b6/56ed68dc50ad9c506840ae359915586b66e5b225b0c637dcba70ff2d84dc/errbot-hl-7.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-18 20:34:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "errbot-hl"
}
JSON