No description
Find a file
2021-05-06 19:28:54 +02:00
.builds Fix style checks on CI 2021-04-18 15:59:40 +02:00
.github/workflows Add GitHub Action to publish releases 2020-06-09 14:10:52 +02:00
contrib contrib/systemd: extend timeout to 3 mins 2020-10-04 22:08:41 +02:00
docker Test baikal using docker 2020-06-09 09:49:18 +02:00
docs Use black to auto-format the codebase 2021-05-06 19:28:54 +02:00
scripts Delete some obsolete leftovers 2021-04-07 08:43:29 +02:00
tests Use black to auto-format the codebase 2021-05-06 19:28:54 +02:00
vdirsyncer Use black to auto-format the codebase 2021-05-06 19:28:54 +02:00
.codecov.yml Use codecov tags 2017-03-22 15:59:54 +01:00
.coveragerc Refactor CI setup 2017-01-30 13:37:23 +01:00
.gitignore Make a maintenance release of vdirsyncer, fix #708 2018-02-05 08:23:45 +01:00
.gitmodules Test baikal using docker 2020-06-09 09:49:18 +02:00
.pre-commit-config.yaml Use black to auto-format the codebase 2021-05-06 19:28:54 +02:00
AUTHORS.rst Credit packagecloud 2020-06-08 19:58:35 +02:00
CHANGELOG.rst Prepare release 0.16.8 2020-06-09 13:27:35 +02:00
CODE_OF_CONDUCT.rst Add CODE_OF_CONDUCT.rst for completeness 2016-08-23 23:48:13 +02:00
config.example config.example: Status path needs to be quoted (#573) 2017-03-02 15:45:07 +01:00
CONTRIBUTING.rst Fix up links for new docs URL 2016-08-15 20:44:45 +02:00
docs-requirements.txt (backport) Make docs build independent of app 2018-06-13 18:25:10 +02:00
ISSUE_TEMPLATE.md ISSUE_TEMPLATE: Clarify importance of debug output 2016-09-19 19:17:39 +02:00
LICENSE Update copyright year 2020-06-08 19:58:35 +02:00
Makefile Remove unused Makefile target 2021-04-06 19:53:00 +02:00
MANIFEST.in Avoid docker-compose 2021-04-06 19:53:00 +02:00
README.rst Use Sourcehut for CI 2021-04-06 19:52:57 +02:00
setup.cfg Simplify coverage handling 2020-06-09 14:57:58 +02:00
setup.py Use black to auto-format the codebase 2021-05-06 19:28:54 +02:00
test-requirements.txt Update tests to work with hypothesis 6 2021-04-07 21:45:41 +02:00

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

.. image:: https://builds.sr.ht/~whynothugo/vdirsyncer.svg
  :target: https://builds.sr.ht/~whynothugo/vdirsyncer
  :alt: CI status

.. image:: https://codecov.io/github/pimutils/vdirsyncer/coverage.svg?branch=master
  :target: https://codecov.io/github/pimutils/vdirsyncer?branch=master
  :alt: Codecov coverage report

.. image:: https://readthedocs.org/projects/vdirsyncer/badge/
  :target: https://vdirsyncer.rtfd.org/
  :alt: documentation

.. image:: https://img.shields.io/pypi/v/vdirsyncer.svg
  :target: https://pypi.python.org/pypi/vdirsyncer
  :alt: version on pypi

.. image:: https://img.shields.io/badge/deb-packagecloud.io-844fec.svg
  :target: https://packagecloud.io/pimutils/vdirsyncer
  :alt: Debian packages

.. image:: https://img.shields.io/pypi/l/vdirsyncer.svg
  :target: https://github.com/pimutils/vdirsyncer/blob/master/LICENCE
  :alt: licence: BSD

- `Documentation <https://vdirsyncer.pimutils.org/en/stable/>`_
- `Source code <https://github.com/pimutils/vdirsyncer>`_

Vdirsyncer is a command-line tool for synchronizing calendars and addressbooks
between a variety of servers and the local filesystem. The most popular usecase
is to synchronize a server with a local folder and use a set of other programs_
to change the local events and contacts. Vdirsyncer can then synchronize those
changes back to the server.

However, vdirsyncer is not limited to synchronizing between clients and
servers. It can also be used to synchronize calendars and/or addressbooks
between two servers directly.

It aims to be for calendars and contacts what `OfflineIMAP
<http://offlineimap.org/>`_ is for emails.

.. _programs: https://vdirsyncer.pimutils.org/en/latest/tutorials/

Links of interest
=================

* Check out `the tutorial
  <https://vdirsyncer.pimutils.org/en/stable/tutorial.html>`_ for basic
  usage.

* `Contact information
  <https://vdirsyncer.pimutils.org/en/stable/contact.html>`_

* `How to contribute to this project
  <https://vdirsyncer.pimutils.org/en/stable/contributing.html>`_

* `Donations <https://vdirsyncer.pimutils.org/en/stable/donations.html>`_

License
=======

Licensed under the 3-clause BSD license, see ``LICENSE``.