summaryrefslogtreecommitdiff
path: root/README.rst
blob: 5d6593ca4a4c040360114600dc2ace43059be752 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Soledad 
==================================================================
*Synchronization Of Locally Encrypted Data Among Devices*

Soledad is the part of LEAP that allows application data to be
securely shared among devices. It provides, to other parts of the 
LEAP project, an API for data storage and sync.

This software is under development.

There are currently three python packages maintained under this
repository:

**leap.soledad.common** common pieces.

.. image:: https://pypip.in/v/leap.soledad.common/badge.png
        :target: https://crate.io/packages/leap.soledad.common

**leap.soledad.client** where the soledad client lives.

.. image:: https://pypip.in/v/leap.soledad.client/badge.png
        :target: https://crate.io/packages/leap.soledad.client

**leap.soledad.server** oh surprise! bits needed for the soledad server.

.. image:: https://pypip.in/v/leap.soledad.server/badge.png
        :target: https://crate.io/packages/leap.soledad.server


Compatibility
-------------

* Server 0.7.x is incompatible with client < 0.7.0 because of modifications on
  encrypted document MAC calculation.


Tests
-----

Client and server tests are both included in leap.soledad.common. If you want
to run tests in development mode you must do the following::

  scripts/develop_mode.sh
  ./run_tests.sh

Note that to run CouchDB tests, be sure you have ``CouchDB`` installed on your
system.