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)

## 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.9.1.tar.gz (14.9 kB view details)

Uploaded Source

Built Distributions

kudubot-0.9.1-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

kudubot-0.9.1-py2-none-any.whl (57.3 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.9.1.tar.gz
Algorithm Hash digest
SHA256 f891ada615d5ffbc0912a92fcb1c0acb1ca8a9bb26d62700b13e129591505406
MD5 532bb038996ff898c9b5ac0ab189d62a
BLAKE2b-256 2d2d16e642895a60088add733be7e03d2eeceb7dc2acb8977cbe49d8fe77f056

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4170513b8fa963b82fd8047b987e4256aee1545eddca707e9dd2a2aa253f7d69
MD5 895a92830d3a01372277ad294ad41a6e
BLAKE2b-256 0691cbee8ef74cf0c49f73035b024905a1263faa2dc0804f9378d5958f63b691

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.9.1-py2-none-any.whl
Algorithm Hash digest
SHA256 146512acb952532dfd247d11c6518da796e1d7b66ecd8f6c8f3216e23348cf9b
MD5 c3ba94bc067c4ddcb0cddaa066be86f0
BLAKE2b-256 67a7b00043a830eaed673042bb788a65c8a88167b357f6b0c319124a1a397c57

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