No description
Find a file
2023-08-23 16:20:21 +02:00
.builds ci: Standardise jobs a bit 2023-07-13 12:33:58 +02:00
contrib Make systemd service restart only once on failure 2022-08-05 21:28:54 +08:00
docs Slightly improve docs for configuring google 2023-07-13 12:34:57 +02:00
scripts Update script to publish deb packages 2021-10-06 00:48:25 +02:00
tests Make broken test as xfail 2023-05-09 11:52:48 +02:00
vdirsyncer Add type hint to vdirsyncer/cli/utils.py 2023-08-23 16:20:21 +02: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.ci] pre-commit autoupdate 2023-05-09 11:52:48 +02:00
AUTHORS.rst Make systemd service restart only once on failure 2022-08-05 21:28:54 +08:00
CHANGELOG.rst docs: add changelog for #1081 2023-08-06 12:45:42 +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 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 Brain typo 2023-03-28 23:23:44 +02:00
pyproject.toml mypy: Drop unnecessary rule exclusion 2023-02-16 16:51:12 +01:00
README.rst Rename master branch to main 2022-08-05 17:07:33 +02:00
setup.py Python 3.10 and 3.11 are also supported 2023-06-26 19:04:23 +02: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``.