monokel 0.0.6

A simple but flexible and containerized observer pipeline for filesystem events featured by docker.

Monokel

Monokel sits on top of Watchdog and exposes an easy way on how to register filesystem event handlers that will eventually run inside a Docker container.

Install

Install and update using pip:

$ pip install -U monokel

Getting Started

The build step

To run an event loop that observes filesystem events from within the container we have to configure and build the actual docker-compose file first.

Monokel provides a build command that will do most of that for you and creates everything the resulting compose file needs to set up the final service.

$ monokel build --help

There are components you can optionally provide and a mandatory one - the python file we call the config.

The (python) config

The idea of the config is to provide a single entry point as a file for the event loop that will eventually run within the docker container. It defines what Observer to run and which EventHandlers to schedule for given paths.

As your eventhandlers might become very specific and require external packages it is by intention that you can make use of them from within the config as long as they can be found in PYPI and installed via pip. See config requirements.

The config file itself can have any name as you can provide the location to the script path.

The config requirements

TBC...