Skip to main content

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")

Restart & Stop task

send a SIGUSR1 when you want to restart the all tasks, send a SIGHUP when you want to stop the all tasks.

TODO

  • [ ] support multi-thread model
  • [ ] colorize logging
  • [ ] statistics web frontend
  • [ ] terminal like interface

License

MIT

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
kuroko-0.1.7.tar.gz (4.2 kB) Copy SHA256 hash SHA256 Source None

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