Skip to main content

Advanced directory tree synchronisation tool

Project description

© 2014+ Thomas Khyn © 2003-2015 Anand B Pillai

Advanced directory tree synchronisation tool

based on Python robocopier by Anand B Pillai

If you like dirsync and find it useful, you may want to thank me and encourage future development by sending a few mBTC / mBCH / mBSV at this address: 1EwENyR8RV6tMc1hsLTkPURtn5wJgaBfG9.

Usage

From the command line:

dirsync <sourcedir> <targetdir> [options]

From python:

from dirsync import sync
sync(sourcedir, targetdir, action, **options)

Main Options

Chosing one option among the following ones is mandatory

--diff, -d

Only report difference between sourcedir and targetdir

--sync, -s

Synchronize content between sourcedir and targetdir

--update, -u

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

--verbose, -v

Provide verbose output

--purge, -p

Purge files when synchronizing (does not purge by default)

--force, -f

Force copying of files, by trying to change file permissions

--twoway, -2

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

--create, -c

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

--ctime

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

--content

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

--ignore, -x patterns

Regex patterns to ignore

--only, -o patterns

Regex patterns to include (exclude every other)

--exclude, -e patterns

Regex patterns to exclude

--include, -i patterns

Regex patterns to include (with precedence over excludes)

Configuration file

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

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)

Project details


Download files

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

Source Distribution

dirsync-2.2.6.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

dirsync-2.2.6-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file dirsync-2.2.6.tar.gz.

File metadata

  • Download URL: dirsync-2.2.6.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for dirsync-2.2.6.tar.gz
Algorithm Hash digest
SHA256 53b557ec5b54bda19c155cd04d7bb935f8b4a74450985f22a9f555a0360570bc
MD5 e7eaad0e11742ac1ef8871e65f175d35
BLAKE2b-256 57039f3435a81035191727f1846783c8598971160172a50fc551b8e799d4eece

See more details on using hashes here.

File details

Details for the file dirsync-2.2.6-py3-none-any.whl.

File metadata

  • Download URL: dirsync-2.2.6-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for dirsync-2.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 88fe72cfcf4d1a6ad307d40439a84e7156b5b3816f1b3ec6b6ff71528e0c807a
MD5 e7b27102c55ffc4d1c4748d5f393156b
BLAKE2b-256 eb1c270c0648c40f6996ccd38572d2c707acab44c590fc339475c5f13249011b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page