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

Uploaded Source

Built Distributions

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

Uploaded Python 3

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

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for kudubot-0.9.0.tar.gz
Algorithm Hash digest
SHA256 378872aa3695b80e9ced063417c5a3b2ccad5ec94ec16c5aa3d26f27d044db69
MD5 15af8b00a412a34b5b34999b805e5656
BLAKE2b-256 41f22c465bf51bebb332ebfd07965b154ae6eae27efbb0a6f4e540ea862d7bbb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7797a1ae09db884e8244d41eaf3bbf55bbb46dca7e3dd99b4562d8bf78824723
MD5 960ec21d0d347e166df977b4739bec98
BLAKE2b-256 c9993912d8c8951dde6df84c7887df46508bd657ac139a4e89463a13e3685f2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kudubot-0.9.0-py2-none-any.whl
Algorithm Hash digest
SHA256 a8c2c861b85fffd416c5c377fbabad89fc00fb83bbc20fdff7549cbc235afaf2
MD5 ac3bb76f6bbaaaf19db56b8aed97232f
BLAKE2b-256 5ef3f8f9a1b80f1909dc50a6f2bb2567cd384d57403d9b377fdb475eba433932

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