pax_global_header 0000666 0000000 0000000 00000000064 13715155050 0014514 g ustar 00root root 0000000 0000000 52 comment=996a6a9481ce50c97069c734a91e35eabd34fca4
pyetesync-0.12.1/ 0000775 0000000 0000000 00000000000 13715155050 0013620 5 ustar 00root root 0000000 0000000 pyetesync-0.12.1/.flake8 0000664 0000000 0000000 00000000037 13715155050 0014773 0 ustar 00root root 0000000 0000000 [flake8]
max-line-length = 120
pyetesync-0.12.1/.gitignore 0000664 0000000 0000000 00000000111 13715155050 0015601 0 ustar 00root root 0000000 0000000 Session.vim
/.venv
/.coverage
/etesync.db
__pycache__
*.egg-info
.*.swp
pyetesync-0.12.1/.travis.yml 0000664 0000000 0000000 00000000245 13715155050 0015732 0 ustar 00root root 0000000 0000000 dist: xenial
language: python
python:
- "3.5"
- "3.6"
- "3.7"
install:
- pip install -r requirements.in/requirements-dev.txt
script:
- ./run_unit_tests.sh
pyetesync-0.12.1/ChangeLog.md 0000664 0000000 0000000 00000005163 13715155050 0015776 0 ustar 00root root 0000000 0000000 # Changelog
## Version 0.12.1
* Change how we import scrypt from hashlib to be more pythonic
## Version 0.12.0
* Update cryptography dep
## Version 0.11.1
* Use the hashlib scrypt implementation if available, otherwise fallback to scrypt or pyscrypt
## Version 0.11.0
* Make sync faster by only fetching entries when journals have changed.
* Change the scrypt dep in setup.py to scrypt (from pyscrypt, which is still supported as a fallback).
* Set the user agent when making requests.
## Version 0.10.0
* Change database model to WAL which should improve concurrency
## Version 0.9.3
* Provide more explicit copyright and licensing information.
## Version 0.9.2
* Remove dev dep (coverage) from setup.py
## Version 0.9.1
* Gracefully handle entries without a UID.
## Version 0.9.0
* Fix reinit of the EteSync object (fixes tests)
* Bump minor version as should have been done in the previous release.
## Version 0.8.4
* Allow users of this library to add tables to the cache database.
* Make the sqlite database more strict (enforce foreign key relations).
## Version 0.8.3
* Fix typo with pytz dependency
## Version 0.8.2
* Add missing pytz dependency
* Upgrade urllib3 and requests
## Version 0.8.1
* Fix pushing entries to shared journals.
## Version 0.8.0
* Add support for read only journals
* Fix issue with having the same journals in the db for different users.
* Journal list fetching: fix stale cache issue.
## Version 0.7.0
* Fix user info to use the correct asymmetric key format
* Sync user info on every protocol sync - needed for encryption password changes.
## Version 0.6.3
* Sync: automatically create user info if doesn't exist
## Version 0.6.2
* Add shell scripts for executing tests
## Version 0.6.1
* Fix journal integrity issue when syncing more than one collection item.
## Version 0.6.0
* Add tasks support
## Version 0.5.6
* Fix broken calling to scrypt
* Fix sync (was broken in some cases) and tests
## Version 0.5.5
* Automatically detect if scrypt is available. If so use it, otherwise revert to pyscript. Setup.py dep remains on pyscypt.
* This is to help distros that don't package pyscrypt
* Update peewee to support version 3 and up
## Version 0.5.4
* Fix peewee dep to be < 3.0.0
## Version 0.5.3
* Change back to pyscript, because scrypt has proven very problematic
* Update all the deps
## Version 0.5.2
* Don't install tests as a package
## Version 0.5.1
* Change from pyscrypt to scrypt (much faster and widely adopted)
## Version 0.5.0
* Add functions to check if the journal list or journals are dirty.
* Add a nicer way to access the journal's info.
* Fix an issue with caching user info
* Improve tests
pyetesync-0.12.1/LICENSE 0000664 0000000 0000000 00000016743 13715155050 0014640 0 ustar 00root root 0000000 0000000 GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
EteSync - Secure Data Sync
This is a python client library for [EteSync](https://www.etesync.com)
[](https://pypi.python.org/pypi/etesync/)
[](https://travis-ci.com/etesync/pyetesync)
[](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 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:
```
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.in/requirements-dev.txt
```
Run `example.py` to export your data:
```
python3 example.py 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.
pyetesync-0.12.1/etesync/ 0000775 0000000 0000000 00000000000 13715155050 0015272 5 ustar 00root root 0000000 0000000 pyetesync-0.12.1/etesync/__init__.py 0000664 0000000 0000000 00000001166 13715155050 0017407 0 ustar 00root root 0000000 0000000 # Copyright © 2017 Tom Hacohen
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, version 3.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see '
' ')
# Token should be saved intead of requested every time
authToken = api.Authenticator(remoteUrl).get_auth_token(email, servicePassword)
etesync = api.EteSync(email, authToken, remote=remoteUrl)
print("Deriving key")
# Very slow operation, should probably be securely cached
etesync.derive_key(userPassword)
print("Syncing")
etesync.sync()
print("Syncing done")
if len(sys.argv) == 6:
journal = etesync.get(sys.argv[5])
# Enable if you'd like to dump the journal
if False:
for entry in journal.list():
printEntry(entry)
# Or interact with the collection
print("Journal items: {}".format(len(list(journal.list()))))
print("Collection items: {}".format(len(list(journal.collection.list()))))
print("Collection: {}".format(list(journal.collection.list())))
else:
for entry in etesync.list():
printJournal(entry)
pyetesync-0.12.1/example_crud.py 0000664 0000000 0000000 00000006750 13715155050 0016652 0 ustar 00root root 0000000 0000000 #!/usr/bin/env python
import etesync as api
# The EtesyncCRUD class exposes methods for each of the CRUD operations
# (Create, Retrieve, Update and Delete) and for sync with the server.
# It handles only one calendar
# The class is initialized with user details, authToken and
# EITHER the encryption password OR the cipher key.
# Intended usage is that a calling program (a CLI) obtains user credentials
# from terminal input or some secure storage (like a key ring)
# and then creates an instance of EtesyncCRUD as follows:
# # call with cipher key
# crud = EtesyncCRUD(email, None, remoteUrl, uid, authToken, cipher_key)
# # call with encryption password
# crud = EtesyncCRUD(email, userPassword, remoteUrl, uid, authToken, None)
# The CLI program can then perform CRUD operations by calling
# crud.create_event, crud.retrieve_event,
# crud.update_event and crud.delete_event
# The CLI must explicitly call crud.sync when needed. For example:
# (a) if the server has been updated from another device
# (b) after any CRUD operation other than Retrieve
# No exception handling is done. That is left to the CLI.
class EtesyncCRUD:
def __init__(self, email, userPassword, remoteUrl, uid, authToken,
cipher_key=None):
"""Initialize
Parameters
----------
email : etesync username(email)
userPassword : etesync encryption password
remoteUrl : url of etesync server
uid : uid of calendar
authToken : authentication token for etesync server
"""
self.etesync = api.EteSync(email, authToken, remote=remoteUrl)
if cipher_key:
self.etesync.cipher_key = cipher_key
else:
self.etesync.derive_key(userPassword)
# needs to be done once on any machine
# else the get on the next line fails
silent or print("Syncing with server. Please wait")
self.etesync.sync()
silent or print("Syncing completed.")
self.journal = self.etesync.get(uid)
self.calendar = self.journal.collection
def create_event(self, event):
"""Create event
Parameters
----------
event : iCalendar file as a string
(calendar containing one event to be added)
"""
ev = api.Event.create(self.journal.collection, event)
ev.save()
def update_event(self, event, uid):
"""Edit event
Parameters
----------
event : iCalendar file as a string
(calendar containing one event to be updated)
uid : uid of event to be updated
"""
ev_for_change = self.calendar.get(uid)
ev_for_change.content = event
ev_for_change.save()
def retrieve_event(self, uid):
r"""Retrieve event by uid
Parameters
----------
uid : uid of event to be retrieved
Returns
-------
iCalendar file (as a string)
"""
return self.calendar.get(uid).content
def all_events(self):
"""Retrieve all events in calendar
Returns
-------
List of iCalendar files (as strings)
"""
return [e.content for e in self.calendar.list()]
def delete_event(self, uid):
"""Delete event and sync calendar
Parameters
----------
uid : uid of event to be deleted
"""
ev_for_deletion = self.calendar.get(uid)
ev_for_deletion.delete()
def sync(self):
r"""Sync with server
"""
self.etesync.sync()
pyetesync-0.12.1/icon.svg 0000664 0000000 0000000 00000017006 13715155050 0015275 0 ustar 00root root 0000000 0000000
image/svg+xml
pyetesync-0.12.1/requirements.in/ 0000775 0000000 0000000 00000000000 13715155050 0016750 5 ustar 00root root 0000000 0000000 pyetesync-0.12.1/requirements.in/development.txt 0000664 0000000 0000000 00000000051 13715155050 0022027 0 ustar 00root root 0000000 0000000 -r ../requirements.txt
pytest
pytest-cov
pyetesync-0.12.1/requirements.in/requirements-dev.txt 0000664 0000000 0000000 00000001532 13715155050 0023011 0 ustar 00root root 0000000 0000000 #
# This file is autogenerated by pip-compile
# To update, run:
#
# pip-compile --output-file=requirements.in/requirements-dev.txt requirements.in/development.txt
#
appdirs==1.4.3
asn1crypto==0.24.0
atomicwrites==1.3.0 # via pytest
attrs==19.1.0
certifi==2019.6.16
cffi==1.12.3
chardet==3.0.4
coverage==4.5.4 # via pytest-cov
cryptography==2.7
furl==2.0.0
idna==2.8
importlib-metadata==0.19 # via pluggy, pytest
more-itertools==7.2.0 # via pytest
orderedmultidict==1.0.1
packaging==19.1
peewee==3.10.0
pluggy==0.12.0 # via pytest
py==1.8.0
pyasn1==0.4.6
pycparser==2.19
pyparsing==2.4.2
pyscrypt==1.6.2
pytest-cov==2.7.1
pytest==5.0.1
python-dateutil==2.8.0
pytz==2019.2
requests==2.22.0
six==1.12.0
urllib3==1.25.3
vobject==0.9.6.1
wcwidth==0.1.7 # via pytest
zipp==0.5.2 # via importlib-metadata
pyetesync-0.12.1/requirements.txt 0000664 0000000 0000000 00000002462 13715155050 0017110 0 ustar 00root root 0000000 0000000 #
# This file is autogenerated by pip-compile
# To update, run:
#
# pip-compile --output-file=requirements.txt setup.py
#
appdirs==1.4.3 # via etesync (setup.py)
asn1crypto==0.24.0 # via etesync (setup.py)
attrs==19.1.0 # via packaging
certifi==2019.6.16 # via requests
cffi==1.12.3 # via cryptography, etesync (setup.py)
chardet==3.0.4 # via requests
cryptography==3.0 # via etesync (setup.py)
furl==2.0.0 # via etesync (setup.py)
idna==2.8 # via etesync (setup.py), requests
orderedmultidict==1.0.1 # via etesync (setup.py), furl
packaging==19.1 # via etesync (setup.py)
peewee==3.10.0 # via etesync (setup.py)
py==1.8.0 # via etesync (setup.py)
pyasn1==0.4.6 # via etesync (setup.py)
pycparser==2.19 # via cffi, etesync (setup.py)
pyparsing==2.4.2 # via etesync (setup.py), packaging
python-dateutil==2.8.0 # via etesync (setup.py), vobject
pytz==2019.2 # via etesync (setup.py)
requests==2.22.0 # via etesync (setup.py)
six==1.12.0 # via cryptography, etesync (setup.py), furl, orderedmultidict, packaging, python-dateutil
urllib3==1.25.3 # via requests
vobject==0.9.6.1 # via etesync (setup.py)
pyetesync-0.12.1/run_all_tests.sh 0000775 0000000 0000000 00000000054 13715155050 0017034 0 ustar 00root root 0000000 0000000 #!/bin/bash
EXTENDED_TESTING=1 pytest "$@"
pyetesync-0.12.1/run_unit_tests.sh 0000775 0000000 0000000 00000000031 13715155050 0017236 0 ustar 00root root 0000000 0000000 #!/bin/bash
pytest "$@"
pyetesync-0.12.1/setenv 0000664 0000000 0000000 00000000032 13715155050 0015042 0 ustar 00root root 0000000 0000000 source .venv/bin/activate
pyetesync-0.12.1/setup.py 0000664 0000000 0000000 00000002055 13715155050 0015334 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
from setuptools import find_packages, setup
exec(open('etesync/_version.py').read())
setup(
name='etesync',
version=__version__,
author='Tom Hacohen',
author_email='tom@stosb.com',
url='https://github.com/etesync/pyetesync',
description='Python client library for EteSync',
keywords=['etesync', 'encryption', 'sync', 'pim'],
license='LGPL-3.0-only',
long_description=open('README.md').read(),
long_description_content_type='text/markdown',
packages=find_packages(exclude=("tests",)),
include_package_data=True,
install_requires=[
'appdirs>=1.4',
'asn1crypto>=0.22',
'cffi>=1.10',
'cryptography>=3.0',
'furl>=0.5',
'idna>=2.5',
'orderedmultidict>=0.7',
'packaging>=16.8',
'peewee>=3.7.0',
'py>=1.4',
'pyasn1>=0.2',
'pycparser>=2.17',
'pyparsing>=2.2',
'python-dateutil>=2.6',
'pytz>=2019.1',
'requests>=2.21',
'six>=1.10',
'vobject>=0.9',
]
)
pyetesync-0.12.1/tests/ 0000775 0000000 0000000 00000000000 13715155050 0014762 5 ustar 00root root 0000000 0000000 pyetesync-0.12.1/tests/__init__.py 0000664 0000000 0000000 00000001143 13715155050 0017072 0 ustar 00root root 0000000 0000000 # Copyright © 2017 Tom Hacohen
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, version 3.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see 