The library for developing systems for messengers and social networks
Project description
Kutana
The library for developing systems for messengers and social networks. Great for developing bots. Refer to example for the showcase of the library abilities.
This library uses generalized attachment types, possible actions e.t.c. for flexibility to use plugins with different backends.
Installation
python -m pip install kutana
Usage
- Create
Kutana
application and add managers. - Register your plugins in the executor. You can import plugin from folders
with function
load_plugins
. Files should be a valid python modules with availableplugin
field with your plugin (Plugin
) or fieldplugins
with list of instances ofPlugin
class. - Start the application.
Example run.py
Token for Vkontakte is loaded from the file "config.json" and plugins are loaded from folder "plugins/"
import json
from kutana import Kutana, load_plugins
from kutana.backends import Vkontakte
# Import configuration
with open("config.json") as fh:
config = json.load(fh)
# Create application
app = Kutana()
# Add manager to application
app.add_backend(Vkontakte(token=config["vk_token"]))
# Load and register plugins
app.add_plugins(load_plugins("plugins/"))
if __name__ == "__main__":
# Run application
app.run()
Example plugin (plugins/echo.py
)
from kutana import Plugin
plugin = Plugin(name="Echo")
@plugin.on_commands(["echo"])
async def _(msg, ctx):
await ctx.reply(ctx.body, attachments=msg.attachments)
If your function exists only to be decorated, you can use
_
to avoid unnecessary names
Available backends
- Vkontakte (for vk.com groups)
- Telegram (for telegram.org bots)
Authors
- Michael Krukov - @michaelkrukov
- Other contributors
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
kutana-4.1.4.tar.gz
(18.3 kB
view hashes)
Built Distributions
kutana-4.1.4-py3.7.egg
(58.8 kB
view hashes)
kutana-4.1.4-py3-none-any.whl
(25.0 kB
view hashes)