From 9fcce07a2bbc5b3d3184b228944d4f71ec3661cd Mon Sep 17 00:00:00 2001 From: Thomas Oettli Date: Wed, 4 Nov 2020 02:34:32 +0100 Subject: [PATCH] change README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 53ffbdf..4d0a4e6 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,10 @@ async def task(event, task_id): #### FileManager FileManager moves, copy or deletes files and/or directories following a list of *rules*. -A rule holds an *action* (move, copy or delete) and a regular expression *src_re*. The FileManager task will be executed if *src_re* matches the path of an event. If the action is copy or move, the destination path *dst_re* is mandatory. If *auto_create* is True, possibly missing subdirectories in *dst_re* are automatically created. If *action* is delete and *rec* is True, non-empty directories will be deleted recursively. It is possible to use Regex subgroups or named-subgroups in *src_re* and *dst_re*. Use *logname* in log messages. +A rule holds an *action* (move, copy or delete) and a regular expression *src_re*. The FileManager task will be executed if *src_re* matches the path of an event. +If the action is copy or move, the destination path *dst_re* is mandatory and if *action* is delete and *rec* is set to True, non-empty directories will be deleted recursively. +With *auto_create* set to True, possibly missing subdirectories in *dst_re* are created automatically. Regex subgroups or named-subgroups may be used in *src_re* and *dst_re*. Use *logname* in log messages. +The optional *filemode*, *dirmode*, *user* and *group* arguments are applied to every file and/or directory that is processed by FileManager. That includes automatically created subdirectories. ```python rule = Rule( action="move", src_re="^/src_path/(?P.*).to_move$",