Metadata-Version: 1.1
Name: kudubot
Version: 0.14.2
Summary: A messaging bot framework
Home-page: https://gitlab.namibsun.net/namboy94/kudubot
Author: Hermann Krumrey
Author-email: hermann@krumreyh.com
License: GNU GPL3
Download-URL: https://gitlab.namibsun.net/namboy94/kudubot/repository/archive.zip?ref=master
Description: # Kudubot
        
        |master|develop|
        |:----:|:-----:|
        |[![build status](https://gitlab.namibsun.net/namboy94/kudubot/badges/master/build.svg)](https://gitlab.namibsun.net/namboy94/kudubot/commits/master)|[![build status](https://gitlab.namibsun.net/namboy94/kudubot/badges/develop/build.svg)](https://gitlab.namibsun.net/namboy94/kudubot/commits/develop)|
        
        ![Logo](kudubot/resources/logo/logo-readme.png)
        
        Kudubot is a chat bot framework designed to work with arbitrary messaging
        services, be it Whatsapp, Telegram, IRC or even Email. The framework is
        completely modular and can be extended with other connection types
        and services.
        
        ## Implementing a Connection.
        
        To implement a new Connection, you will have to create a subclass
        the ```kudubot.connections.Connection.Connection``` class and implement the
        various abstract methods.
        
        To integrate the connection with Kudubot, make sure your class is in
        your system's python path (i.e. importable) and add an import statement
        to the config file located at ```$HOME/.kudubot/connections.conf``` 
        that would import your Connection class.
        
        For examples see:
        
        * [kudubot-cli](kudubot/connections/cli)
        * [kudubot-telegram](kudubot/connections/telegram)
        * [kudubot-whatsapp](kudubot/connections/whatsapp)
        
        ## Implementing a Service
        
        To implement a Service, you will have to create a subclass of the
        ```kudubot.services.Service.Service``` class and implement the various
        abstract methods.
        
        To integrate the service with Kudubot, make sure your class is in
        your system's python path (i.e. importable) and add an import statement
        to the config file located at ```$HOME/.kudubot/services.conf``` 
        that would import your Service class.
        
        For examples see:
        
        * [kudubot-simple-responder](kudubot/services/simple_responder)
        * [kudubot-reminder](kudubot/services/reminder)
        * [kudubot-anime-reminder](kudubot/services/anime_reminder)
        
        
        ## Further Information
        
        * [Changelog](https://gitlab.namibsun.net/namboy94/kudubot/raw/master/CHANGELOG)
        * [Gitlab](https://gitlab.namibsun.net/namboy94/kudubot)
        * [Github](https://github.com/namboy94/kudubot)
        * [Python Package Index Site](https://pypi.python.org/pypi/kudubot)
        * [Documentation(HTML)](https://docs.namibsun.net/html_docs/kudubot/index.html)
        * [Documentation(PDF)](https://docs.namibsun.net/pdf_docs/kudubot.pdf)
        * [Git Statistics (gitstats)](https://gitstats.namibsun.net/gitstats/kudubot/index.html)
        * [Git Statistics (git_stats)](https://gitstats.namibsun.net/git_stats/kudubot/index.html)
        * [Test Coverage](https://coverage.namibsun.net/kudubot/index.html)
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Communications :: Chat
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
