Commit 72dae07a authored by Guillaume Binet's avatar Guillaume Binet

some old refs (gbin / err)

parent dfec262d
......@@ -25,16 +25,16 @@
:target: http://errbot.io
Err
===
Errbot
======
Err is a chatbot. It allows you to start scripts interactively from your chatrooms
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.
Err is available as open source software and released under the GPL v3 license.
Errbot is available as open source software and released under the GPL v3 license.
Features
......@@ -47,9 +47,9 @@ Features
- `Telegram <https://www.telegram.org/>`_ (built-in support)
- `XMPP <http://xmpp.org>`_ (built-in support)
- IRC (built-in support)
- `Gitter <https://gitter.im/>`_ (Follow the instructions from `here <https://github.com/gbin/err-backend-gitter>`_ to install it)
- `CampFire <https://campfirenow.com/>`_ (Follow the instructions from `here <https://github.com/gbin/err-backend-campfire>`_ to install it)
- `TOX <https://tox.im/>`_ (Follow the instructions from `here <https://github.com/gbin/err-backend-tox>`_ to install it)
- `Gitter <https://gitter.im/>`_ (Follow the instructions from `here <https://github.com/errbotio/err-backend-gitter>`_ to install it)
- `CampFire <https://campfirenow.com/>`_ (Follow the instructions from `here <https://github.com/errbotio/err-backend-campfire>`_ to install it)
- `TOX <https://tox.im/>`_ (Follow the instructions from `here <https://github.com/errbotio/err-backend-tox>`_ to install it)
**Administration**
......@@ -60,7 +60,7 @@ After the initial installation and security setup, Err can be administered by ju
- 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 <https://github.com/gbin/err/wiki/Logging-with-Sentry>`_
- logs: can be inspected from chat or streamed to Sentry.
**Developer features**
......@@ -77,36 +77,36 @@ After the initial installation and security setup, Err can be administered by ju
Community and support
---------------------
If you have a question or want to share your latest plugin creation: feel free to join the chat on `gitter <https://gitter.im/gbin/err>`_. Err has also a `google plus community <https://plus.google.com/b/101905029512356212669/communities/117050256560830486288>`_. You can ping us on Twitter with the hashtag ``#errbot``.
But if you have a bug to report or wish to request a feature, please log them `here <https://github.com/gbin/err/issues>`_.
If you have a question or want to share your latest plugin creation: feel free to join the chat on `gitter <https://gitter.im/errbotio/errbot>`_. Errbot has also a `google plus community <https://plus.google.com/b/101905029512356212669/communities/117050256560830486288>`_. You can ping us on Twitter with the hashtag ``#errbot``.
But if you have a bug to report or wish to request a feature, please log them `here <https://github.com/errbotio/errbot/issues>`_.
Contributions
-------------
Feel free to fork and propose changes on `github <https://www.github.com/gbin/err>`_
Feel free to fork and propose changes on `github <https://www.github.com/errbotio/errbot>`_
Prerequisites
-------------
Err runs under Python 3.3+ and Python 2.7 on Linux, Windows and Mac. For some chatting systems you'll need a key or a login for your bot to access it.
Errbot runs under Python 3.3+ and Python 2.7 on Linux, Windows and Mac. For some chatting systems you'll need a key or a login for your bot to access it.
Installation
------------
If you can, we recommend to setup a `virtualenv <https://pypi.python.org/pypi/virtualenv>`_.
Err may be installed directly from PyPi using pip by issuing::
Errbot may be installed directly from PyPi using pip by issuing::
pip install err
Or if you wish to try out the latest, bleeding edge version::
pip install https://github.com/gbin/err/archive/master.zip
pip install https://github.com/errbotio/errbot/archive/master.zip
**Extra dependencies**
setup.py only installs the bare minimum dependencies needed to run Err.
setup.py only installs the bare minimum dependencies needed to run Errbot.
Depending on the backend you choose, additional requirements need to be installed.
+------------+-----------------------------------------------------------------------------------+
......@@ -129,11 +129,11 @@ Depending on the backend you choose, additional requirements need to be installe
**Configuration**
After installing Err, you must create a data directory somewhere on your system where
config and data may be stored. Find the installation directory of Err, then copy the
After installing Errbot, you must create a data directory somewhere on your system where
config and data may be stored. Find the installation directory of Errbot, then copy the
file <install_directory>/errbot/config-template.py to your data directory as config.py
(If you installed Err via pip, the installation directory will most likely be
(If you installed Errbot via pip, the installation directory will most likely be
/usr/lib64/python<python_version_number>/site-packages/errbot)
Read the documentation within this file and edit the values as needed so the bot can
......@@ -141,7 +141,7 @@ connect to your chosen backend (XMPP, Hipchat, Slack ...) server.
**Starting the daemon**
The first time you start Err, it is recommended to run it in foreground mode. This can
The first time you start Errbot, it is recommended to run it in foreground mode. This can
be done with::
errbot
......@@ -149,19 +149,19 @@ be done with::
In many cases, just using ``errbot`` will be enough as it is generally added to the ``$PATH``
automatically. Please pass -h or --help to ``errbot`` to get a list of supported parameters.
Depending on your situation, you may need to pass --config or --backend when starting
Err.
Errbot.
If all that worked, you can now use the -d (or --daemon) parameter to run it in a
detached mode::
errbot --daemon
**Hacking on Err's code directly**
**Hacking on Errbot's code directly**
It's important to know that as of version 2.0, Err is written for Python 3. In order
to run under Python 2.7 the code is run through 3to2 at install time. This means that
while it is possible to run Err under Python 3.3+ directly from a source checkout, it
is not possible to do so with Python 2.7. If you wish to develop or test with Err's
It's important to know that Errbot is written for Python 3 but can run under 2.7. In order
to run it under Python 2.7 the code is run through 3to2 at install time. This means that
while it is possible to run Errbot under Python 3.3+ directly from a source checkout, it
is not possible to do so with Python 2.7. If you wish to develop or test with Errbot's
code under 2.7, you must run::
python setup.py develop
......@@ -177,7 +177,7 @@ Or in graphical mode (you'll need to install the dependency pyside for that)::
Interacting with the Bot
------------------------
After starting Err, you should add the bot to your buddy list if you haven't already.
After starting Errbot, you should add the bot to your buddy list if you haven't already.
You can now send commands directly to the bot, or issue commands in a chatroom that
the bot has also joined.
......@@ -208,19 +208,19 @@ You will probably want to update your plugins periodically. This can be done wit
!repos update all
Note: Please pay attention when you install a plugin, it may have additional
dependencies. If the plugin contains a requirements.txt then Err wil automatically
dependencies. If the plugin contains a requirements.txt then Errbot will automatically
check them and warn you when you are missing dependencies.
Writing plugins
---------------
Writing your own plugins is extremely simple. As an example, this is all it takes
to create a "Hello, world!" plugin for Err::
to create a "Hello, world!" plugin for Errbot::
from errbot import BotPlugin, botcmd
class Hello(BotPlugin):
"""Example 'Hello, world!' plugin for Err"""
"""Example 'Hello, world!' plugin for Errbot"""
@botcmd
def hello(self, msg, args):
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment