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
124 commits 1 branch 70 tags 3.8 MiB
Python 98.6%
Shell 0.8%
Makefile 0.6%
Find a file
Markus Unterwaditzer ae4c1e3c83 move travis badge back to top
2014-03-15 20:01:42 +01:00
tests More tests 2014-03-13 16:22:50 +01:00
vdirsyncer Show help when running vdirsyncer 2014-03-14 16:55:34 +01:00
.gitignore Add test suite instructions 2014-03-01 20:39:59 +01:00
.travis.yml Remove cache 2014-03-10 22:09:19 +01:00
example.cfg Better example config name 2014-03-08 22:41:42 +01:00
install-deps.sh Goddamnit 2014-03-09 23:14:19 +01:00
LICENSE Copyright headers, more docstrings 2014-02-28 14:44:07 +01:00
README.rst move travis badge back to top 2014-03-15 20:01:42 +01:00
requirements.txt Add leif to requirements.txt 2014-03-11 18:26:34 +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
    py.test