Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

The engine for developing bots for soc. networks, instant messengers and other systems.

Project description

Kutana logo

Documentation Status Build Status CodeFactor Codacy Badge Coverage Status Codebeat Badge PyPI version Plugins repo

Kutana

The engine for developing bots for soc. networks, instant messengers and other systems. You can find repository with plugins for kutana here.

Installation

  • Download and install python (3.5.3+)
https://www.python.org/downloads/
  • Install kutana module (use python3 if needed)
python -m pip install kutana

Usage

  • Create Kutana engine and add controllers.
  • Register your plugins in the executor. You can import plugin from folders with function load_plugins. Files should be a valid python modules with available plugin field with your plugin (Plugin).
  • Start engine.

Example run.py (token for VKController is loaded from the file "configuration.json" and plugins are loaded from folder "plugins/")

from Kutana import *

# Create engine
kutana = Kutana()

# Add VKController to engine
kutana.add_controller(
    VKController(load_configuration("vk_token", "configuration.json"))
)

# Load and register plugins
kutana.executor.register_plugins(*load_plugins("plugins/"))

# Run engine
kutana.run()

Example plugins/echo.py

from kutana import Plugin

plugin = Plugin(name="Echo")

@plugin.on_startswith_text("echo")
async def on_echo(message, attachments, env):
    await env.reply("{}".format(env.body))

Available controllers

  • VKController (vk.com groups)

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
kutana-1.0.0-py3-none-any.whl (16.7 kB) Copy SHA256 hash SHA256 Wheel py3 Oct 15, 2018
kutana-1.0.0.tar.gz (18.6 kB) Copy SHA256 hash SHA256 Source None Oct 15, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page