Skip to main content

Python module that wraps system calls to rsync

Project description


Python module that wraps system calls to rsync


  • rsync
  • python 3.6+


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


  • Basic file sync
import sysrsync'/home/user/foo.txt',
# runs 'rsync /home/users/foo.txt /home/server/files'
  • ssh with options
import sysrsync'/home/user/files',
# runs 'rsync -a /home/users/files/ myserver:/home/server/files'
  • exclusions
import sysrsync'/home/user/files',
             exclusions=['file_to_exclude', 'unwanted_file'])
# runs 'rsync -a /home/users/files/ myserver:/home/server/files --exclude file_to_exclude --exclude unwanted_file'


argument type default description
cwd str os.getcwd() working directory in which subprocess will run the rsync command
strict bool True raises RsyncError when rsync return code is different than 0
verbose bool False verbose mode: currently prints rsync command before executing
**kwargs dict Not Applicable arguments that will be forwarded to call to sysrsync.get_rsync_command

returns: subprocess.CompletedProcess

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


argument type default description
source str - Source folder or file
destination str - Destination folder
source_ssh Optional[str] None Remote ssh client where source is located
destination_ssh Optional[str] None Remote ssh client where destination is located
exclusions Iterable[str] [] List of excluded patterns as in rsync's --exclude
sync_source_contents bool True Abstracts the elusive trailing slash behaviour that source normally has when using rsync directly, i.e. when a trailing slash is present in source, the folder's content is synchronized with destination. When no trailing slash is present, the folder itself is synchronized with destination.
options Iterable[str] [] List of options to be used right after rsync call, e.g. ['-a', '-v'] translates to rsync -a -v

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

raises: RemotesError when both source_ssh and target_ssh are set. Normally linux rsync distribution disallows source and destination to be both remotes.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sysrsync, version 0.1.2
Filename, size & hash File type Python version Upload date
sysrsync-0.1.2.tar.gz (4.7 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page