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-cli](https://gitlab.namibsun.net/namboy94/kudubot-cli)
* [kudubot-telegram](https://gitlab.namibsun.net/namboy94/kudubot-telegram)
* [kudubot-whatsapp](https://gitlab.namibsun.net/namboy94/kudubot-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](https://gitlab.namibsun.net/namboy94/kudubot-simple-responder)
* [kudubot-reminder](https://gitlab.namibsun.net/namboy94/kudubot-reminder)
* [kudubot-anime-reminder](https://gitlab.namibsun.net/namboy94/kudubot-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)

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.11.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distributions

kudubot-0.11.0-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

kudubot-0.11.0-py2-none-any.whl (68.5 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.11.0.tar.gz
Algorithm Hash digest
SHA256 b716ab177283f1a032fbb08bd2a147eaf76d537bb2b8c7d60699a510e2e65f81
MD5 e215bba37b1e2c0e97dd54cf267d0678
BLAKE2b-256 e3c7575376947bce3b2dc5a4d7583728ce623ce28d37670a87fe611ab00f9baa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea210f2bca41e10485c3e22b9897791a019057012bbc0424951f4613983eb3c6
MD5 471acf706d50406fd5be426c99abcb5b
BLAKE2b-256 74de4276e9a2d10f106fd37473da29753e94b5d94bf1705f11130161c95dd8fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.11.0-py2-none-any.whl
Algorithm Hash digest
SHA256 96db394c67661ee3276d6048d150d24a6398dfb93345d334160bd3f8157e3565
MD5 19192e2a2e34fa81c03b0a5cf7514b7c
BLAKE2b-256 fb548c2cec8f8ff1c2a991fa34b81b83a8eb3af822f6744e3605d3634777cf1e

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