sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-03-25 08:55:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
156 commits 1 branch 70 tags 3.8 MiB
Python 98.6%
Shell 0.8%
Makefile 0.6%
Find a file
Markus Unterwaditzer b8986d6edf Merge branch 'owncloud' 
Fix #16
2014-03-20 15:18:54 +01:00
tests Use pytest-xprocess for process management 2014-03-20 15:02:35 +01:00
vdirsyncer Extra sanity checks and debugging 2014-03-19 15:31:49 +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 example config name 2014-03-08 22:41:42 +01:00
install-deps.sh Don't try to clone if owncloud repo already exists 2014-03-20 15:18:11 +01:00
LICENSE Copyright headers, more docstrings 2014-02-28 14:44:07 +01:00
README.rst add information on DAV_SERVER envvar to readme 2014-03-19 16:11:56 +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 switch to rst 2014-03-15 19:58:38 +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

The environment variable ``DAV_SERVER`` specifies which CalDAV/CardDAV server
to test against. It has to be set for both scripts, ``install-deps.sh`` and
``run-tests.sh``.

  - ``DAV_SERVER=radicale``: The default, installs the latest Radicale release
    from PyPI. Very fast, because no additional processes are needed.
  - ``DAV_SERVER=radicale_git``: Same as ``radicale``, except that the
    installation happens from their git repo. ``install-deps.sh`` is slightly
    slower with this.
  - ``DAV_SERVER=owncloud``: Uses latest ownCloud release. Very slow
    installation, very slow tests.