Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package usage and documentation #45

Closed
Praful932 opened this issue Jan 26, 2022 · 1 comment
Closed

Package usage and documentation #45

Praful932 opened this issue Jan 26, 2022 · 1 comment

Comments

@Praful932
Copy link

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"])
@tkhyn
Copy link
Owner

tkhyn commented Feb 9, 2025

For the first point, the **options in the doc is pretty self-explanatory for someone who knows a little bit of python ... the ** clearly denotes that options are to be passed as keyword arguments.
I will add a bit of documentation for the regex options.

@tkhyn tkhyn closed this as completed in e3df4b6 Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants