No description
Find a file
Hugo Osvaldo Barrera 2e619806a0 Drop support for Python 3.8
Note that recent commits introduced syntax unsupported by Python 3.8
already.
2025-09-20 13:05:03 +02:00
.builds builds(archlinux-py313): adds python-tenacity package 2025-09-12 17:02:28 +07:00
contrib Use list expansion instead of concatenation 2025-09-20 12:45:56 +02:00
docs Drop support for Python 3.8 2025-09-20 13:05:03 +02:00
scripts Allow specifying deb distro/ver via env vars 2023-12-18 14:35:48 +01:00
tests Execute one assertion per line 2025-09-20 12:45:56 +02:00
vdirsyncer Drop support for Python 3.8 2025-09-20 13:05:03 +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
.envrc Use direnv to set up a virtualenv for development 2024-12-09 14:18:24 +01:00
.gitignore git-ignore coverage file 2021-06-12 18:39:28 +02:00
.pre-commit-config.yaml Update linting tools 2025-04-07 18:42:07 +02:00
.readthedocs.yaml Add explicit configuration for readthedocs 2025-02-13 13:34:13 +01:00
AUTHORS.rst AUTHORS: add samm81 2025-09-12 16:25:00 +07:00
CHANGELOG.rst Drop support for Python 3.8 2025-09-20 13:05:03 +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 Move test dependencies into pyproject.toml 2025-04-07 18:47:44 +02:00
MANIFEST.in Drop etesync 2021-10-05 22:13:59 +02:00
publish-release.yaml Remove stale references to setup.py 2025-08-28 22:57:55 +02:00
pyproject.toml Drop support for Python 3.8 2025-09-20 13:05:03 +02:00
README.rst OfflineIMAP url Update 2024-10-31 22:43:45 +01: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
<https://www.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>`_

Dockerized
=================
If you want to run `Vdirsyncer <https://vdirsyncer.pimutils.org/en/stable/>`_ in a
Docker environment, you can check out the following GitHub Repository:

* `Vdirsyncer DOCKERIZED <https://github.com/Bleala/Vdirsyncer-DOCKERIZED>`_

Note: This is an unofficial Docker build, it is maintained by `Bleala <https://github.com/Bleala>`_.

License
=======

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