Skip to main content

A messaging bot framework

Project 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-telegram](https://gitlab.namibsun.net/namboy94/kudubot-telegram)

## 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](https://gitlab.namibsun.net/namboy94/kudubot-simple-responder)

## 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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kudubot-0.8.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distributions

kudubot-0.8.0-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

kudubot-0.8.0-py2-none-any.whl (55.9 kB view details)

Uploaded Python 2

File details

Details for the file kudubot-0.8.0.tar.gz.

File metadata

  • Download URL: kudubot-0.8.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for kudubot-0.8.0.tar.gz
Algorithm Hash digest
SHA256 6d73173c6f3cb8dfb16cce1c4821daa2ef1ab797dbe3da44adfd99f0c0e56a68
MD5 8e14a3e8c8ba578e524529579ef1b600
BLAKE2b-256 d993c8f6e4a96aabaf4bea34d1693af94715a71e500c99df003d94cfbfaa00c0

See more details on using hashes here.

File details

Details for the file kudubot-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kudubot-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 042bf8d0c96fc5517685ac1a210b9629b396a88046b7aabef32e3044503c7f4e
MD5 76aab8659a99a4ff992bd74239765293
BLAKE2b-256 86c6073ac89b230b33a50a1b891d9adb952cc156a0adcd293f3d09d2a011326e

See more details on using hashes here.

File details

Details for the file kudubot-0.8.0-py2-none-any.whl.

File metadata

File hashes

Hashes for kudubot-0.8.0-py2-none-any.whl
Algorithm Hash digest
SHA256 a449329f35d7bbed897523a5fee3f8b56e0adee65d8c7363e480be677897200b
MD5 1520d4d0cea2d46e508747c5778c521b
BLAKE2b-256 2329845c8de6bfa11f321d9670292db2816ee612902189c52a096c1397f9be95

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page