Only report difference between sourcedir and targetdir

Synchronize content between sourcedir and targetdir

Update existing content between sourcedir and targetdir

If you use one of the above options (e.g. sync ) most of the time, you may consider defining the action option in a Configuration file parsed by dirsync.

Additional Options

Provide verbose output

Purge files when synchronizing (does not purge by default)

Force copying of files, by trying to change file permissions

Update files in source directory from target directory (only updates target from source by default)

Create target directory if it does not exist (By default, target directory should exist.)

Also takes into account the source file's creation time (Windows) or the source file's last metadata change (Unix)

Takes into account ONLY content of files. Synchronize ONLY different files. At two-way synchronization source files content have priority if destination and source are existed

Regex patterns to ignore

Regex patterns to include (exclude every other)

Regex patterns to exclude

Regex patterns to include (with precedence over excludes)

Configuration files are only used when using the command line, and ignored when dirsync is called from within Python.

If you want to use predefined options all the time, or if you need specific options when ‘dirsyncing’ a specific source directory, dirsync looks for two configuration files, by order or priority (the last takes precedence):

~/.dirsync
source/directory/.dirsync

A ~/.dirsync configuration file is automatically created the first time dirsync is ran from the command line. It enables sync mode by default.

Warning

Any source/directory/.dirsync file is automatically excluded from the files to compare. You have to explicitly include using the --include option it if you want it to be covered by the comparison.

The command line options always override the values defined in the configuration files.

The configuration files must have a defaults section, and the options are as defined above. The only exception is for the option action , which can take 3 values diff , sync or update .

Example config file:

[defaults]
action = sync
create = True

Custom logger

From python, you may not want to have the output sent to stdout . To do so, you can simply pass your custom logger via the logger keyword argument of the sync function:

sync(sourcedir, targetdir, action, logger=my_logger, **options)

Download files

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