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

Uploaded Source

Built Distributions

kudubot-0.10.0-py3-none-any.whl (32.8 kB view details)

Uploaded Python 3

kudubot-0.10.0-py2-none-any.whl (58.2 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.10.0.tar.gz
Algorithm Hash digest
SHA256 f7630b0fd38c07aff61d64fddf090a8c26ae47c47ee9e75c0796d6e4a968a64c
MD5 952cbae4f7d8be6c7b67787a22f185f3
BLAKE2b-256 98084e35e199dae7f7ddecfdf071f68da5315e5e59d547fd3274402ff29428d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6aae2121dd7fd8d8801bbfbe79b5b32c6a927f016be75fd1789e0a8b136cdcf8
MD5 b4220cc51e5c3fecdf85b27165956864
BLAKE2b-256 4f4fbfe1a32891e4f369d15f6adde85fd2def246eb168e14fa1dfb72f89bfe5b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.10.0-py2-none-any.whl
Algorithm Hash digest
SHA256 61fba88cb6712e4b6c3858901c039becd1fcdc3c4aa9d72c6b90fff0ce6ea43e
MD5 6b59a3b030ee1cc42e3c56b1ca73d478
BLAKE2b-256 78a0ae25149856aa8fd2cbf7df44395d42212a0a46631d5d2e7a30fa440dd402

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