vdirsyncer

mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-03-25 08:55:50 +00:00

No description

Find a file

Markus Unterwaditzer 7bc6c41164 Flake 8		2014-03-21 17:43:04 +01:00
tests	Flake 8	2014-03-21 17:43:04 +01:00
vdirsyncer	Flake 8	2014-03-21 17:43:04 +01:00
.gitignore	Use pytest-xprocess for process management	2014-03-20 15:02:35 +01:00
.travis.yml	Argh, Travis	2014-03-19 21:32:20 +01:00
example.cfg	Better verbosity CLI option, no config value	2014-03-21 17:14:21 +01:00
install-deps.sh	Skip radicale tests for broken database storage.	2014-03-21 17:38:01 +01:00
LICENSE	Copyright headers, more docstrings	2014-02-28 14:44:07 +01:00
README.rst	Remove information nobody will use	2014-03-20 15:26:07 +01:00
requirements.txt	Use pytest-xprocess for process management	2014-03-20 15:02:35 +01:00
run-tests.sh	Use pytest-xprocess for process management	2014-03-20 15:02:35 +01:00
setup.cfg	Copyright headers, more docstrings	2014-02-28 14:44:07 +01:00
setup.py	Exclude tests from installation	2014-03-20 22:22:54 +01:00

README.rst

==========
vdirsyncer
==========

.. image:: https://travis-ci.org/untitaker/vdirsyncer.png?branch=master
    :target: https://travis-ci.org/untitaker/vdirsyncer

vdirsyncer synchronizes your calendars and addressbooks between two storages.
The supported storages are CalDAV, CardDAV and
`vdir <https://github.com/untitaker/vdir>`_.

While i use it daily and haven't experienced data loss (even when vdirsyncer
crashed), i don't know if the documentation is sufficient. If you have any
questions regarding the usage, feel free to open a new issue.

It aims to be for CalDAV and CardDAV what
`OfflineIMAP <http://offlineimap.org/>`_ is for IMAP.

How to use
==========

Copy ``example.cfg`` to ``~/.vdirsyncer/config`` and edit it. You can use the
`VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will
read the config from.

Run ``vdirsyncer --help``.

How to run the tests
====================

::

    sh install-deps.sh
    sh run-tests.sh