Skip to main content

ResourceSync library and client

Project description


Build Status Test Coverage

resync is a ResourceSync library with supporting client scipts, written in python. ResourceSync is a synchronization framework for the web consisting of various capabilities that allow third party systems to remain synchronized with a server's evolving resources. The capabilities can be combined in a modular manner to meet local or community requirements.

Client usage

Typical client usage to synchronize from a source at to a set of local files would be


which will create or update a local directory ./ Alternatively, the destination directory may be specified explicitly::

resync-sync /tmp/my_copy

Option details and a number of different modes are described with::

resync-sync -h

Python library usage

Typical library use in a source (create and output a Resource List)::

from resync import Resource, ResourceList

rl = ResourceList()
rl.add( Resource('', lastmod='2013-01-01') )
rl.add( Resource('', lastmod='2013-01-02') )
print rl.as_xml()

Typical library use in a destination (get and examine a Capability List)::

from resync import CapabilityList

# Read Capability List and show supported capabilities
cl = CapabilityList()"")
for resource in cl:
    print "supports %s (at %s)" % (resource.capability,resource.uri)


The client and library are designed to work with Python 3.5 and up. (The last version supporting Python 2.7 was 1.0.9, also on PyPI)

Automatic installation

pip install resync

rsync is listed in PyPI and can be installed with pip or easy_install.

Manual installation from github

cd /tmp
git clone git://
cd resync/
python build
python install

This will install the library code in the appropriate place within a user-space python setup, including the clients resync-sync, resync-build and resync-explorer. Use of sudo to install in system spaces is generally discouraged.

The source code is maintained on Github and there may be branches/versions available there that are not yet packaged for PyPI.

See also


Thanks to: Bernhard Haslhofer, [Robert Sanderson](< and other contributors.

See for guidelines for contributing.

Copyright and License

Copyright 2012--2020 Simeon Warner and contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


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

resync-2.0.1.tar.gz (59.9 kB view hashes)

Uploaded source

Built Distribution

resync-2.0.1-py3-none-any.whl (78.0 kB view hashes)

Uploaded py3

Supported by

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