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](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)

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

Uploaded Source

Built Distributions

kudubot-0.14.0-py3-none-any.whl (75.0 kB view details)

Uploaded Python 3

kudubot-0.14.0-py2-none-any.whl (138.6 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.14.0.tar.gz
Algorithm Hash digest
SHA256 d6bfbcc2a65de6140283e3357869bc72db7761a32d80a3e59f2f3cd2f179280a
MD5 30158b1c850dca9fb3e3403c6240a95e
BLAKE2b-256 8464322bc68ca36eac51c90b3a1166193923441c9c3a2aa61fd506e0f8fe8a41

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0be271136b2cb205a4d296a2eca901de0fc70f47006cde04588f7c734e370a43
MD5 ddbc673f6454d5032aa03488c60bb1d8
BLAKE2b-256 bd4d51c4bf7c0139f43a82f7a58ff9ae96b9eb47ef3879bed323d2a4222681a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.14.0-py2-none-any.whl
Algorithm Hash digest
SHA256 66136d7471054ca2bf82dc237cd95bed914fc8e4f58957a5e3e4b0cf64a56f29
MD5 465f8d366e61432046ca1c01f51f5dc4
BLAKE2b-256 0d1742beba26fcf114b48c93775f33b6bb8580ff47285a92cc68e8b1d8ddadd3

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