pysyncml 0.1 documentation

Welcome to pysyncml

Contents   ::   Command Line Programs  »

Welcome to pysyncml

Welcome to the pysyncml library, a pure-python implementation of the SyncML adapter framework and protocol. SyncML is a protocol for allowing abstract objects to be synchronized between multiple clients and a server.

Important

2012/07/01: pysyncml is currently alpha. That means very little really works yet! However, it is being actively developed, so check back in a couple of months.

Functional components as of 0.1.dev-r30:

  • Client-side SyncML framework with support for CRUD operations, i.e. Add/Replace/Delete Sync commands.
  • Client-side synchronization of “note” datatype.

Goals

The pysyncml project has the following goals, some of them diverge critically from other SyncML implementations and are the reasons for creating a new package instead of building on other existing implementations:

Limitations

It is the goal of the project to get a minimally functional library going in the shortest possible timeframe. To that end, the following features of SyncML will NOT be implemented until a later phase, even if this means that the library does not provide a conformant implementation:

Installation

Installation of pysyncml is near-trivial with PIP:

$ pip install pysyncml

or, using easy_install:

$ easy_install pysyncml

Documentation

Coding Standards

Here are a few of the coding standards that the pysyncml project conforms to that deviate or go beyond PEP-8:

Resources

Feedback

Please send any feedback, comments, suggestions, etc. to <hardcore@uberdev.org>. For bug reports, please use the SourceForge ticket system (see Resources).

Contents   ::   Command Line Programs  »