commit 901a0bdeaf60fcd2a584046163b77a6b30951c89 parent d3f5512b446ee026766294ec15bcf8f7abb97a5e Author: Erik Loualiche <[email protected]> Date: Tue, 25 Feb 2025 16:41:18 -0600 added readme! Diffstat:
| M | .gitignore | | | 1 | - |
| A | README.md | | | 45 | +++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 45 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore @@ -17,6 +17,5 @@ wheels/ # temporary ignores test-sync tests -README.md esync.toml sync.log diff --git a/README.md b/README.md @@ -0,0 +1,45 @@ +# esync + +A basic file sync tool based on watchdog/watchman and rsync. + +Tested for rsync version 3.4.1 and python >=3.9. +For more information on rsync and options, visit the [manual page.](https://linux.die.net/man/1/rsync) + + +## Installation + +With pip +```bash +git clone https://github.com/eloualic/esync.git +cd esync +pip install -e . +``` + +## Usage + +### Configuration + +To create a configuration file, run the following command: +```bash +esync init --help +``` + +### Basic command + +Local sync +```bash +esync sync -l test-sync/source -r test-sync/target +``` + +Remote sync +```bash +esync sync -l test-sync/source -r user@remote:/path/to/target +esync sync -l test-sync/source -r remote:/path/to/target # or based on ssh config +``` + + +## Future + +- Two step authentication +- Statistics +- General option for rsync