rsyncer

https://github.com/zmeir/rsyncer
Admin
rsyncer is a simple rsync wrapper for Python, offering both a one-function-call interface and a more...
Tokens:1,801
Snippets:10
Trust Score:4.7
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Sync Directory with Syncer

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a directory from a source path to a destination path using the Syncer object within a 'with' statement.

```Python
from rsyncer import rsync

with rsync.Syncer(source="/path/to/dir", dest="/path/to/destination") as s:
    s.run()
```

--------------------------------

### Sync Remote Directory with Syncer

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a directory from a remote source to a local destination using the Syncer object, specifying the remote server via source_ssh.

```Python
from rsyncer import rsync

with rsync.Syncer(source="/path/to/dir", dest="/path/to/destination", source_ssh="user@server.org") as s:
    s.run()
```

--------------------------------

### Sync Single File with Syncer

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a single file from a source path to a destination path using the Syncer object within a 'with' statement.

```Python
from rsyncer import rsync

with rsync.Syncer(source="/path/to/file", dest="/path/to/destination") as s:
    s.run()
```

--------------------------------

### Sync Directory with One-Function-Call

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a directory from a source path to a destination path using the one-function-call method.

```Python
from rsyncer import rsync

rsync.rsync(source="/path/to/dir", dest="/path/to/destination")
```

--------------------------------

### Sync Remote Directory with One-Function-Call

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a directory from a remote source to a local destination using the one-function-call method, specifying the remote server via source_ssh.

```Python
from rsyncer import rsync

rsync.rsync(source="/path/to/dir", dest="/path/to/destination", source_ssh="user@server.org")
```

--------------------------------

### Run Rsync with One-Function-Call

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Executes an rsync command using the simple one-function-call interface. This function returns a boolean indicating success or failure.

```Python
from rsyncer.rsync import rsync

suc = rsync(...)
if suc:
    print("rsync run successfully.")
else:
    print("There was an error running rsync.")
```

--------------------------------

### Manage Rsync with Syncer Object

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Utilizes the Syncer object for more advanced rsync operations, such as creating, running, and monitoring rsync commands. The Syncer object manages temporary files and can be used with a 'with' statement for automatic cleanup.

```Python
from rsyncer import rsync

s = rsync.Syncer(...)
s.run()
s.get_command()
s.progress()
s.close() # or s.exit() to kill the rsync process
```

```Python
from rsyncer import rsync

with rsync.Syncer(...) as s:
    s.run()
    s.get_command()
    s.progress()
    # and/or other operations
```

--------------------------------

### Sync Single File with One-Function-Call

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a single file from a source path to a destination path using the one-function-call method.

```Python
from rsyncer import rsync

rsync.rsync(source="/path/to/file", dest="/path/to/destination")
```

--------------------------------

### Exclude File with Syncer

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a directory while excluding a specific file using the Syncer object and the 'excludes' parameter.

```Python
from rsyncer import rsync

with rsync.Syncer(source="/path/to/dir", dest="/path/to/destination", excludes=["/path/to/dir/tmp.txt"]) as s:
    s.run()
```

--------------------------------

### Exclude File with One-Function-Call

Source: https://github.com/zmeir/rsyncer/blob/main/README.md

Syncs a directory while excluding a specific file using the one-function-call method and the 'excludes' parameter.

```Python
from rsyncer import rsync

rsync.rsync(source="/path/to/dir", dest="/path/to/destination", excludes=["/path/to/dir/tmp.txt"])
```
Tokens:
Raw