Skip to main content

A library for replicating your python class between multiple servers, based on raft protocol

Project description

Build Status Release License gitter

PySyncObj is a python library that provides ability to sync your data between multiple servers. - It use raft protocol for leader election and log replication. - It supports log compaction. It use fork for copy-on-write while serializing data on disk. - It supports in-memory and on-disk serialization. You can use in-memory mode for small data and on-disk for big one. - It has encryption - you can set password and use it in external network. - It supports python2 and python3. No dependencies required (only optional one, eg. cryptography). - Configurable event loop - it can works in separate thread with it’s own event loop - or you can call onTick function inside your own one. - Convenient interface - you can easily transform arbitrary class into a replicated one (see example below).

Install

PySyncObj itself:

pip install pysyncobj

Cryptography for encryption (optional):

pip install cryptography

Usage

Consider you have a class that implements counter:

class MyCounter(object):
    def __init__(self):
        self.__counter = 0

    def incCounter(self):
        self.__counter += 1

    def getCounter(self):
        return self.__counter

So, to transform your class into a replicated one: - Inherit it from SyncObj - Initialize SyncObj with a self address and a list of partner addresses. Eg. if you have serverA, serverB and serverC and want to use 4321 port, you should use self address serverA:4321 with partners [serverB:4321, serverC:4321] for your application, running at serverA; self address serverB:4321 with partners [serverA:4321, serverC:4321] for your application at serverB; self address serverC:4321 with partners [serverA:4321, serverB:4321] for app at serverC. - Mark all your methods that modifies your class fields with @replicated decorator. So your final class will looks like:

class MyCounter(SyncObj):
    def __init__(self):
        super(MyCounter, self).__init__('serverA:4321', ['serverB:4321', 'serverC:4321'])
        self.__counter = 0

    @replicated
    def incCounter(self):
        self.__counter += 1

    def getCounter(self):
        return self.__counter

And thats all! Now you can call incCounter on serverA, and check counter value on serverB - they will be synchronized. You can look at examples and syncobj_ut.py for more use-cases.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pysyncobj, version 0.1.9
Filename, size File type Python version Upload date Hashes
Filename, size pysyncobj-0.1.9.tar.gz (21.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page