<p align="center">
  <img width="120" src="icon.svg" />
  <h1 align="center">EteSync - Secure Data Sync</h1>
</p>

This is a python client library for [EteSync](https://www.etesync.com)

![GitHub tag](https://img.shields.io/github/tag/etesync/pyetesync.svg)
[![PyPI](https://img.shields.io/pypi/v/etesync.svg)](https://pypi.python.org/pypi/etesync/)
[![Chat on freenode](https://img.shields.io/badge/irc.freenode.net-%23EteSync-blue.svg)](https://webchat.freenode.net/?channels=#etesync)

This module provides a python API to interact with an EteSync server.
It currently implements AddressBook and Calendar access, and supports two-way
sync (both push and pull) to the server.
It doesn't currently implement pushing raw journal entries which are needed for
people implementing new EteSync journal types which will be implemented soon.

To install, please run:

```
pip install etesync
```

The module works and the API is tested (see [tests/](tests/)), however there still
may be some oddities, so please report if you encounter any.

There is one Authenticator endpoint, and one endpoint for the rest of the API
interactions.

The way it works is that you run "sync", which syncs local cache with server.
Afterwards you can either access the journal directly, or if you prefer,
you can access a collection, for example a Calendar, and interact with the
entries themselves, which are already in sync with the journal.

Check out [example.py](example.py) for a basic usage example, or the tests
for a more complete example.

While this is stable enough for usage, it still may be subject to change, so
please watch out for the changelog when updating version.
Docs are currently missing but are planned.

## Running the example script

You'll need virtualenv to get the dependencies.

Either install your distro's package, for example `python3-virtualenv`

or get it from pip:

```
pip3 install virtualenv
```

You may also need to make sure you have the OpenSSL development package
installed (e.g. `openssl-dev`).

Check out this repository:

```
git clone git@github.com:etesync/pyetesync.git
cd pyetesync
```

Setup the environment:

```
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
```

Run `example.py` to export your data:

```
python3 example.py <email> <auth password> <encryption password> https://api.etesync.com
```

You may need to surround your passwords in quotes and you may need to escape special characters with a `\`.
Please note, that depending on your setup, passing your passwords as command line parameters may not be completely secure,
so it would be better if you manually edit the file.

And all of your data will be copied to a local database located at `~/.etesync/data.db`.

## Running the tests

Some to the tests are unit tests, but some are integration tests who need an actual EteSync service with a few user names set up in order for them to work.

You'd need to run your local server: https://github.com/etesync/server-skeleton/

And then add two users:

  - test@localhost
  - test2@localhost

Password for both: SomePassword

That's it.

