No description
Find a file
Hugo Osvaldo Barrera f3714fc493 Add type hints and configure mypy
Configure mypy as a pre-commit hook and add all type hints necessary for
mypy to pass.

There's still more work to be done here typing a lot more code, but this
provides a clear starting point.
2021-08-03 19:23:37 +02:00
.builds Run Fastmail tests on CI 2021-06-26 18:25:35 +02:00
contrib Make this bit more readable 2021-07-07 18:46:13 +02:00
docs Update link for orage 2021-06-27 12:37:33 +02:00
scripts Update build script for Debian/Ubuntu 2021-05-06 19:11:43 +02:00
tests Add type hints and configure mypy 2021-08-03 19:23:37 +02:00
vdirsyncer Add type hints and configure mypy 2021-08-03 19:23:37 +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
.pre-commit-config.yaml Add type hints and configure mypy 2021-08-03 19:23:37 +02:00
AUTHORS.rst fixed password.fetch option not using environment 2021-06-13 16:14:46 +02:00
CHANGELOG.rst Add changelog entries for asyncio support 2021-06-26 13:40:38 +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 Only measure coverage of vdirsyncer/ 2021-07-10 17:35:50 +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 Add type hints and configure mypy 2021-08-03 19:23:37 +02:00
setup.py Add type hints and configure mypy 2021-08-03 19:23:37 +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=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``.