Skip to content

README.md

Latest commit

 

History

History
45 lines (36 loc) · 1.42 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.42 KB
Raw

SQL storage plugin for errbot

About

Errbot is a python chatbot, this storage plugin allows you to use it with SQL databases as a persistent storage. By using SQLAlchemy, it has the support for Firebird, Microsoft SQL Server, MySQL, Oracle, PostgreSQL, SQLite, Sybase, IBM DB2, Amazon Redshift, exasol, Sybase SQL Anywhere, MonetDB.

Installation

  1. Install the support for the database you want to use. See SQLalchemy doc
  2. Then you need to add this section to your config.py, following this example:
BOT_EXTRA_STORAGE_PLUGINS_DIR='/home/gbin/err-storage'
STORAGE = 'SQL'
STORAGE_CONFIG = {
   'data_url': 'postgresql://scott:tiger@localhost/test',
   }
  1. Start your bot in text mode: errbot -T to give it a shot.

If you want to migrate from the local storage to SQL, you should be able to backup your data (with STORAGE commented) then restore it back with STORAGE uncommented.

Running Tests

To run the automated test suite:

  1. Create and activate a Python virtual environment: 
    python3 -m venv .venv
source .venv/bin/activate
  2. Install the dependencies and testing requirements: 
    pip install -r requirements.txt errbot pytest tox
  3. Run the tests using pytest directly: 
    pytest
    Or run both tests and style checks using tox: 
    tox