b3j0f.sync 0.0.3
Synchronizer design pattern library
License: MIT License
Keywords: utils,tools,development,synchronizer,design pattern,sync,observer,model,interoperability

Description
===========

This system is dedicated to help to synchronize data of resources.

.. image:: https://img.shields.io/pypi/l/b3j0f.sync.svg
   :target: https://pypi.python.org/pypi/b3j0f.sync/
   :alt: License

.. image:: https://img.shields.io/pypi/status/b3j0f.sync.svg
   :target: https://pypi.python.org/pypi/b3j0f.sync/
   :alt: Development Status

.. image:: https://img.shields.io/pypi/v/b3j0f.sync.svg
   :target: https://pypi.python.org/pypi/b3j0f.sync/
   :alt: Latest release

.. image:: https://img.shields.io/pypi/pyversions/b3j0f.sync.svg
   :target: https://pypi.python.org/pypi/b3j0f.sync/
   :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/implementation/b3j0f.sync.svg
   :target: https://pypi.python.org/pypi/b3j0f.sync/
   :alt: Supported Python implementations

.. image:: https://img.shields.io/pypi/wheel/b3j0f.sync.svg
   :target: https://travis-ci.org/b3j0f/sync
   :alt: Download format

.. image:: https://travis-ci.org/b3j0f/sync.svg?branch=master
   :target: https://travis-ci.org/b3j0f/sync
   :alt: Build status

.. image:: https://coveralls.io/repos/b3j0f/sync/badge.png
   :target: https://coveralls.io/r/b3j0f/sync
   :alt: Code test coverage

.. image:: https://img.shields.io/pypi/dm/b3j0f.sync.svg
   :target: https://pypi.python.org/pypi/b3j0f.sync/
   :alt: Downloads

.. image:: https://readthedocs.org/projects/b3j0fsync/badge/?version=master
   :target: https://readthedocs.org/projects/b3j0fsync/?badge=master
   :alt: Documentation Status

.. image:: https://landscape.io/github/b3j0f/sync/master/landscape.svg?style=flat
   :target: https://landscape.io/github/b3j0f/sync/master
   :alt: Code Health

Links
=====

- `Homepage`_
- `PyPI`_
- `Documentation`_

Installation
============

pip install b3j0f.sync

Features
========

The global architecture is composed of four classes:

- Synchronizer: class which is linked to several stores in order to propagate data CRUD operations on these last ones.
- Store: class which represents a set of data, and uses one Accessor per data type in order to access to self data.
- Accessor: class which permits to access and create data.
- Data: specific to an accessor, it is the abstraction class used to exchange data information among stores.

Therefore, one Store can be used by several synchronizers, and one Accessor can be used by several Stores.

The Synchronizer and the Store are configurables (see `b3j0f.conf`_). Configuration files are installed in the ``~/etc/`` directory.

If you want to specialize this system to your own needs, you have to extend abstract classes with implementation of 6 CRUD methods for the Accessor.

The system does not use semantical mechanisms, therefore, the system is in a **best effort** mode instead to be exhaustive.

Examples
--------

- `b3j0f.dmts`_: development management tool synchronizer.

Limitations
===========

Name limitation
---------------

In order to ensure data consistency among several stores, the system choose to find any data from its name and context name (aka, name of embedding data).

Therefore, this system is not able to synchronize data which are of the same type of other data, in the same context, and with the same name.

Perspectives
============

- break the `name limitation`_ with a store dedicated to ensure correspondance between store data ids.
- use a data id of type int instead of type str, for memory reasons.
- wait feedbacks during 6 months before passing it to a stable version.
- Cython implementation.

Donation
========

.. image:: https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png
   :target: https://gratipay.com/b3j0f/
   :alt: I'm grateful for gifts, but don't have a specific funding goal.

.. _Homepage: https://github.com/b3j0f/sync
.. _Documentation: http://b3j0fsync.readthedocs.org/en/master/
.. _PyPI: https://pypi.python.org/pypi/b3j0f.sync/

.. _`b3j0f.conf`: https://github.com/b3j0f/conf
.. _`b3j0f.dmts`: https://github.com/b3j0f/dmts