mirror of
https://github.com/samsonjs/vdirsyncer.git
synced 2026-03-25 08:55:50 +00:00
41 lines
1.2 KiB
ReStructuredText
41 lines
1.2 KiB
ReStructuredText
==========
|
|
vdirsyncer
|
|
==========
|
|
|
|
vdirsyncer synchronizes your calendars and addressbooks between two storages.
|
|
The supported storages are CalDAV, CardDAV, arbitrary HTTP resources, `vdir
|
|
<https://github.com/untitaker/vdir>`_ and `some more
|
|
<https://vdirsyncer.readthedocs.org/en/latest/api.html#storages>`_.
|
|
|
|
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
|