No description
Find a file
2024-01-28 20:15:08 +01:00
.builds ci: Standardise jobs a bit 2023-07-13 12:33:58 +02:00
contrib Ensure type annotations are backwards compatible 2023-10-29 16:04:23 +01:00
docs Remove broken contact link 2024-01-28 20:15:08 +01:00
scripts Allow specifying deb distro/ver via env vars 2023-12-18 14:35:48 +01:00
tests Require matching BEGIN and END lines in vobjects 2023-12-13 10:31:32 -05:00
vdirsyncer Require matching BEGIN and END lines in vobjects 2023-12-13 10:31:32 -05:00
.codecov.yml Simplify coverage submission 2021-07-06 23:45:35 +02:00
.coveragerc Refactor CI setup 2017-01-30 13:37:23 +01:00
.gitignore git-ignore coverage file 2021-06-12 18:39:28 +02:00
.gitlab-ci.yml Run test on Python 3.7 2021-08-07 17:23:10 +02:00
.pre-commit-config.yaml pre-commit autoupdate 2023-09-24 12:35:40 +02:00
AUTHORS.rst Require matching BEGIN and END lines in vobjects 2023-12-13 10:31:32 -05:00
CHANGELOG.rst Require matching BEGIN and END lines in vobjects 2023-12-13 10:31:32 -05: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 Simplify management of documentation dependencies 2023-01-31 01:11:24 +01: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 Simplify management of documentation dependencies 2023-01-31 01:11:24 +01:00
MANIFEST.in Drop etesync 2021-10-05 22:13:59 +02:00
publish-release.yaml Fast-mail publishing if credentials are missing 2023-12-18 14:35:48 +01:00
pyproject.toml Ensure type annotations are backwards compatible 2023-10-29 16:04:23 +01:00
README.rst Rename master branch to main 2022-08-05 17:07:33 +02:00
setup.py Ensure type annotations are backwards compatible 2023-10-29 16:04:23 +01:00
test-requirements.txt Initial async support 2021-06-26 13:40:35 +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=main
  :target: https://codecov.io/github/pimutils/vdirsyncer?branch=main
  :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/main/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``.