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

Uploaded Source

Built Distributions

kudubot-0.12.0-py3-none-any.whl (66.0 kB view details)

Uploaded Python 3

kudubot-0.12.0-py2-none-any.whl (123.2 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.12.0.tar.gz
Algorithm Hash digest
SHA256 951a3cd49dbb4d3bafbf317f6bb09a9550354dc580300dca4ed136fa09fb0a6d
MD5 b06ed1b87da39858f93de597025eb61d
BLAKE2b-256 db66b8a90d7cf52280ae091ec76307275bbe78e80bc4be3cddf5131f079db782

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 047ded8865a1996a4dffa69da0523038b21bd8b3c47eaa69e45ae8991bcc19aa
MD5 c82c2be549d9e540da9856a5238352b8
BLAKE2b-256 37408f4c6ac5d02c80a7bedd919794ab7948cce7942625bdb0e97710021f4bb2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.12.0-py2-none-any.whl
Algorithm Hash digest
SHA256 7059844dea09a2a505a295a3b2bfa5b7475d590605851beb13e3b514129cab7a
MD5 60f9289485e2455d6a2521dd77cde872
BLAKE2b-256 2ae43023c987fd66ae92692394b2d8ada5bc744f525e1928ff3789c3df3b9045

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