execlib package docs

Index Module Index Search Page

Top-level module overview

execlib.Handler	Subclasses WebSocketEndpoint to be attached to live reload endpoints.
execlib.Listener	Implements a file system watcher.
execlib.Router	Route events to registered callbacks
execlib.Server	Wraps up a development static file server and live reloader.
execlib.listeners

Auto-reference contents

• execlib package
  • Subpackages
    • execlib.listeners package
    • execlib.routers package
    • execlib.syncers package
    • execlib.util package
  • Submodules
    • execlib.event module
    • execlib.handler module
    • execlib.listener module
    • execlib.router module
    • execlib.server module

Contents

• Documentation

Overview

execlib is a lightweight multi-threaded job framework written in Python. It implements a simple event-based model over core Python utilities like ThreadPoolExecutor to facilitate reactivity and manage concurrent responses.

There are a few top-level classes exposed by the package:

• Router: Central event routing object. Routers facilitate route registration, allowing for pattern-based matching of events to arbitrary callback functions. For example, you could have a function that converts a PDF file to a collection images (callback), and want this function to be called for a new files (event) that match the glob *.pdf (pattern).

• Listener: Connective event listening object, often created directly by router instances. Listeners pay attention to events arising along registered routes of an affiliated router, passing them through (after optional delays, debouncing, filtering, etc). In the above example, the associated Listener instance might wrap a tool like iNotify to dynamically respond to file events.

• Server: Long-running process manager for listeners and optional live-reloading via HTTP. Interfaces with listener start() and shutdown() for graceful interruption.

Install

pip install execlib

Development

Documentation

pip install execlib[docs]

Testing

pip install execlib[tests]