https://github.com/overcommitted/ParcelKit

ParcelKit integrates Core Data with Dropbox using the Dropbox Datastore API
https://github.com/overcommitted/ParcelKit

Last synced: about 1 month ago
JSON representation

ParcelKit integrates Core Data with Dropbox using the Dropbox Datastore API

• Host: GitHub
• URL: https://github.com/overcommitted/ParcelKit
• Owner: overcommitted
• License: mit
• Created: 2013-07-18T15:06:15.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-04-10T02:49:28.000Z (almost 10 years ago)
• Last Synced: 2024-10-29T03:48:16.834Z (2 months ago)
• Language: Objective-C
• Homepage:
• Size: 45 MB
• Stars: 567
• Watchers: 36
• Forks: 38
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - ParcelKit - ParcelKit integrates Core Data with Dropbox using the Dropbox Datastore API (etc)
• awesome - ParcelKit - ParcelKit integrates Core Data with Dropbox using the Dropbox Datastore API (etc)

README

        


# ParcelKit [![Build Status](https://travis-ci.org/overcommitted/ParcelKit.png?branch=master)](https://travis-ci.org/overcommitted/ParcelKit)

ParcelKit integrates Core Data with [Dropbox](http://www.dropbox.com) using the Dropbox [Datastore API](https://www.dropbox.com/developers/datastore).

Installation

------------

ParcelKit can be added to a project using [CocoaPods](https://github.com/cocoapods/cocoapods). We also distribute a framework build.

### Using CocoaPods [![Badge w/ Version](https://cocoapod-badges.herokuapp.com/v/ParcelKit/badge.png)](https://cocoadocs.org/docsets/ParcelKit)

```

// Podfile

pod 'ParcelKit', '~> 2.1'

```

and

```

pod install

```

### Framework

1. Open the ParcelKit.xcodeproj project

2. Select the “Framework” scheme

3. Build (⌘B) the Framework

4. Open the Products section in Xcode, right click “libParcelKit.a”, and select “Show in Finder”

5. Drag and drop the “ParcelKit.framework” folder into your iPhone/iPad project

6. Edit your build settings and add `-ObjC` to “Other Linker Flags”

Usage

-----

Include ParcelKit in your application.

    #import 

Initialize an instance of the ParcelKit sync manager with the Core Data managed object context and the Dropbox data store that

should be used for listening for changes from and writing changes to.

    

    PKSyncManager *syncManager = [[PKSyncManager alloc] initWithManagedObjectContext:self.managedObjectContext datastore:self.datastore];

        

Associate the Core Data entity names with the corresponding Dropbox data store tables.  

    [syncManager setTable:@"books" forEntityName:@"Book"];

    

Start observing changes from Core Data and Dropbox.

    [syncManager startObserving];

    

Hold on to the sync manager reference.

    

    self.syncManager = syncManager;

Set up Core Data

----------------



ParcelKit requires an extra attribute inside your Core Data model. 

* __syncID__ with the type __String__. The __Indexed__ property should also be checked.

Make sure you add this attribute to each entity you wish to sync.

An alternative attribute name may be specifed by changing the syncAttributeName property on the sync manager object.

Documentation

-------------

* [ParcelKit Reference](http://overcommitted.github.io/ParcelKit/) documentation

Example Application

-------------------

* [Toado](https://github.com/daikini/toado) - Simple task manager demonstrating the integration of Core Data and Dropbox using ParcelKit.

    

Requirements

------------

* iOS 6.1 or higher

* Dropbox Sync SDK 3.1.0 or higher

* Xcode 5 or higher

License

-------

[MIT](https://github.com/overcommitted/ParcelKit/blob/master/LICENSE).