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

Uploaded Source

Built Distributions

kudubot-0.13.0-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

kudubot-0.13.0-py2-none-any.whl (124.6 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.13.0.tar.gz
Algorithm Hash digest
SHA256 6ad325f0d05335aedfc02b15b821d8e49618f5b15796520114024ef050543e6b
MD5 454d29ffd084b84c9998abf2c979cbd3
BLAKE2b-256 d259bf21b0b8fd305420b949921ec48f0ede162bfe0e3f1e484a8588798ba9f7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ad90724feafe5503bad3e77cf76be9725ea2831a524f213d67afc61c6166847
MD5 d2f263b4058bad9abd0045ca33a55fac
BLAKE2b-256 4b5c8ffcfc6f9d402657118bd6e5f5114b75b25dcfc759893b20fab4f698afa2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.13.0-py2-none-any.whl
Algorithm Hash digest
SHA256 1d21c361a0622c14596b41b5d6fdbfd58fd5a994e3c4540ac383bf2dd6634085
MD5 207687d2d26719b122d038a04cafa293
BLAKE2b-256 2f564ad67343f03ea894611640a000279c96c3e5e0068148c74be457e16e6c56

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