sysrsync

Simple and safe native rsync wrapper for Python 3

Requirements

• rsync
• python 3.6+

development:

• poetry (be sure to have both poetry and pip upgraded to the latest version)

Installation

pip install sysrsync

Basic rules

• Syncs source contents by default, so it adds a trailing slash to the end of source, unless sync_source_contents=False is specified
• Removes trailing slash from destination
• Extra arguments are put right after rsync
• Breaks if source_ssh and destination_ssh are both set

Usage

• Basic file sync

import sysrsync

sysrsync.run(source='/home/user/foo.txt',
             destination='/home/server/bar')
# runs 'rsync /home/users/foo.txt /home/server/files'

• sync whole folder

import sysrsync

sysrsync.run(source='/home/user/files',
             destination='/home/server/',
             sync_source_contents=False)
# runs 'rsync /home/user/files /home/server'

• sync folder contents

import sysrsync

sysrsync.run(source='/home/user/files',
             destination='/home/server/',
             sync_source_contents=True)
# runs 'rsync /home/user/files/ /home/server'

• ssh with options

import sysrsync

sysrsync.run(source='/home/user/files',
             destination='/home/server/files',
             destination_ssh='myserver',
             options=['-a'])
# runs 'rsync -a /home/users/files/ myserver:/home/server/files'

• exclusions

import sysrsync

sysrsync.run(source='/home/user/files',
             destination='/home/server/files',
             destination_ssh='myserver',
             options=['-a'],
             exclusions=['file_to_exclude', 'unwanted_file'])
# runs 'rsync -a /home/user/files/ myserver:/home/server/files --exclude file_to_exclude --exclude unwanted_file'

• Private key

import sysrsync

sysrsync.run(source='/home/user/files',
             destination='/home/server/files',
             destination_ssh='myserver',
             private_key="totally_secure_key")
# runs 'rsync --rsh='ssh -i totally_secure_key' /home/user/files/ myserver:/home/server/files'

API

sysrsync.run

returns: subprocess.CompletedProcess

raises:

• RsyncError when strict = True and rsync return code is different than 0 (Success)

sysrsync.get_rsync_command

returns: List[str] -> the compiled list of commands to be used directly in subprocess.run

raises:

• RemotesError when both source_ssh and destination_ssh are set. Normally linux rsync distribution disallows source and destination to be both remotes.
• PrivateKeyError when private_key doesn't exist

Contributing

• Fork project
• Install dependencies with poetry install
• Make changes
• Lint with poetry run pylint ./sysrsync
• Test with poetry run python -m unittest
• Run end-to-end tests with bash end-to-end-tests/run-tests.sh
• Submit changes with a pull request

Contributors ✨

Thanks goes to these wonderful people (emoji key):

plazmakeks 💻

Steve Henderson 💻

This project follows the all-contributors specification. Contributions of any kind welcome!