Skip to main content
2025 Python Packaging Survey is now live!  Take the survey now

Minimalistic Python Bot Framework

Project description

Kuroko

Minimalistic Python Task Executor Framework

Requirements

Installation

pip install kuroko

Usage

examples

5sec interval task execution

import kuroko

class MyBot(kuroko.Bot):

    @kuroko.timer(5)
    def echo_pong(self):
        print("pong")

bot = MyBot()
bot.start()

crontab like task execution

class MyBot(kuroko.Bot):

    @kuroko.crontab('*/5 * * * *')
    def echo_pong(self):
        print("pong")

watchdog thin wrapper

class MyBot(kuroko.Bot):

    @kuroko.watch
    def echo_pong(self, event):
        print("pong", event)

    @kuroko.watch(patterns=['*.py'])
    def echo_ping(self, event):
        print("ping", event)

logging

class MyBot(kuroko.Bot):

    @kuroko.crontab('*/5 * * * *')
    def echo_pong(self):
        self.log.info("app logging")

TODO

  • colorize logging

  • statistics web frontend

  • terminal like interface

License

MIT

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page