Basic usage

Here’s an example for syncing the django.contrib.sites app.

1. Create an api view

# myapp.views

from synctools.routing import Route

route = Route()

@route.app("sites", "sites")

2. Add the urls to your project

# myproject.urls

from django.conf.urls import include, url
from myapp.views import route

urlpatterns += [
    url("^sync/", include(route.urlpatterns)),
]

3. Sync data from the remote endpoint

# myclient.py

from synctools.client import Client

client = Client(
    api_url="https://myserver.com/sync/",
    api_token="<token>",
)

if __name__ == "__main__":
    client.sync("sites")

The sites app can now be synced locally from a remote data source by calling:

python myclient.py

Installation

Synctool can be installed from PyPI:

pip install django-synctool

Requirements

This library requires Django >= 1.7 and either Python 2.7 or Python >= 3.3.

Documentation

You can read the documentation here.