Metadata-Version: 1.1
Name: kuroko
Version: 0.1.5
Summary: Minimalistic Python Bot Framework
Home-page: https://github.com/hhatto/kuroko
Author: Hideo Hattori
Author-email: hhatto.jp@gmail.com
License: MIT License
Description: Kuroko
        =======
        Minimalistic Python Task Executor Framework
        
        
        Requirements
        ============
        - Python2.7+
        - Logbook_
        - crontab_
        - watchdog_
        
        .. _Logbook: https://pypi.python.org/pypi/Logbook
        .. _crontab: https://pypi.python.org/pypi/crontab
        
        
        Installation
        ============
        
        ::
        
            pip install kuroko
        
        
        Usage
        =====
        examples
        
        5sec interval task execution
        ----------------------------
        
        .. code-block:: python
        
            import kuroko
        
            class MyBot(kuroko.Bot):
        
                @kuroko.timer(5)
                def echo_pong(self):
                    print("pong")
        
            bot = MyBot()
            bot.start()
        
        crontab like task execution
        ---------------------------
        
        .. code-block:: python
        
            class MyBot(kuroko.Bot):
        
                @kuroko.crontab('*/5 * * * *')
                def echo_pong(self):
                    print("pong")
        
        watchdog_ thin wrapper
        ----------------------
        
        .. code-block:: python
        
            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)
        
        
        .. _watchdog: https://pypi.python.org/pypi/watchdog
        
        logging
        -------
        
        .. code-block:: python
        
            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
        
Keywords: bot framework
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
