No description
Find a file
Markus Unterwaditzer 5d727c26e5 Actually only filter out PRODID key
It might happen that we filter out a SUMMARY line or similar which
coincidentally contains "PRODID"
2014-05-19 17:01:26 +02:00
docs Add missing file! 2014-05-18 23:15:15 +02:00
tests Add GuessAuth to authentication methods 2014-05-18 23:22:55 +02:00
vdirsyncer Actually only filter out PRODID key 2014-05-19 17:01:26 +02:00
.gitignore Add some docs 2014-05-18 22:25:42 +02:00
.travis.yml Add Python 3.4 2014-05-03 19:56:43 +02:00
build.sh Add GuessAuth to authentication methods 2014-05-18 23:22:55 +02:00
CONTRIBUTING.rst Be Python 3 compatible 2014-04-16 15:28:01 +02:00
example.cfg SSL doesn't seem to work on rtfd.org 2014-05-18 23:25:05 +02:00
LICENSE Copyright headers, more docstrings 2014-02-28 14:44:07 +01:00
README.rst Move some stuff around. 2014-05-18 23:12:10 +02:00
setup.cfg Move testserver-specific code into different repos 2014-04-12 16:23:32 +02:00
setup.py Start depending on icalendar 2014-05-15 13:34:11 +02:00

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

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

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

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

.. image:: https://coveralls.io/repos/untitaker/vdirsyncer/badge.png?branch=master
    :target: https://coveralls.io/r/untitaker/vdirsyncer?branch=master

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

vdirsyncer requires Python >= 2.7 or Python >= 3.3.

As all Python packages, vdirsyncer can be installed with ``pip``::

    pip install --user vdirsyncer

Then 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`` and check out `the documentation
<https://vdirsyncer.readthedocs.org/>`_.

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

::

    sh build.sh install
    sh build.sh run