dirsync icon indicating copy to clipboard operation
dirsync copied to clipboard

Package usage and documentation

Open Praful932 opened this issue 4 years ago • 0 comments

Thanks for publishing this library, Creating this Issue to add some general usage which I didn't see in the README and had to refer the codebase to understand

  • The additional options needs to be passed in either as a dictionary or as a parameter to the sync function, For example to force create, the statement would look like - sync(source_path, dest_path, "sync", create = True)
  • Other additional options which involve regexes, It expects a list and the regex is a re.match not re.search so the regex search starts from the start, so for example if you wanted to only include files with extension .py, The statement would be something like sync(source_path, dest_path, "sync", create = True, only = [r".+?\.py"])

Praful932 avatar Jan 26 '22 16:01 Praful932