https://github.com/benhoff/vexbot

Chat bot featuring multiple services connected to a bot instance using messaging
https://github.com/benhoff/vexbot

bot chat chatbot irc linux socketio xmpp youtube

Last synced: 1 day ago
JSON representation

Chat bot featuring multiple services connected to a bot instance using messaging

• Host: GitHub
• URL: https://github.com/benhoff/vexbot
• Owner: benhoff
• License: gpl-3.0
• Created: 2015-08-26T04:57:04.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-25T22:04:04.000Z (about 6 years ago)
• Last Synced: 2024-09-17T19:28:30.961Z (10 days ago)
• Topics: bot, chat, chatbot, irc, linux, socketio, xmpp, youtube
• Language: Python
• Homepage:
• Size: 2.46 MB
• Stars: 63
• Watchers: 12
• Forks: 21
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.md

Awesome Lists containing this project

README

        
======

vexbot

======

|readthedocs| |codeclimate|

.. |readthedocs| image:: https://readthedocs.org/projects/vexbot/badge/?version=latest

  :target: http://vexbot.readthedocs.io/en/latest/?badge=latest

  :alt: Documentation Status

.. |codeclimate| image:: https://api.codeclimate.com/v1/badges/c17129f65b11dfef34c0/maintainability.svg

  :target: https://codeclimate.com/github/benhoff/vexbot/badges/gpa.svg

  :alt: Climate Status

Pluggable bot

Under development. Very useable but currently not feature complete.

Requirements

------------

Requires python 3.5 for asyncio and only runs on linux.

If you're a python developer, you can probably get this to run on not linux.

Installation

------------

You will need an active DBus user session bus. Depending on your distro, you might already have one (Arch linux, for example).

For Ubuntu:

.. code-block:: bash

  $ apt-get install dbus-user-session python3-gi python3-dev python3-pip build-essential

For everyone:

.. code-block:: bash

  $ python3 -m venv 

.. code-block:: bash

  $ source /bin/activate

.. code-block:: bash

  $ ln -s /usr/lib/python3/dist-packages/gi /lib/python3.5/site-packages/

.. code-block:: bash

  $ pip install vexbot[process_manager]

Configuring

-----------

Make sure your virtual environment is activated. Then run:

.. code-block:: bash

  $ vexbot_generate_certificates

.. code-block:: bash

 $ vexbot_generate_unit_file

.. code-block:: bash

 $ systemctl --user daemon-reload

Your bot is ready to run!

Running

-------

.. code-block:: bash

 $ systemctl --user start vexbot

 

Or

.. code-block:: bash

  $ vexbot_robot

Please note that vexbot has a client/server architecture. The above commands will launch the server. To launch the command line client:

.. code-block:: bash

  $ vexbot

Exit the command line client by typing `!exit` or using `ctl+D`.