Released: April 2016 (2.1.2)
** Important notice: this is an early pre-release version and is subject to change **
MendeleyKit is a standalone library/framework providing convenience methods and classes for using the Mendeley API in Mac OSX or iOS applications.
Since its launch in Oct 2014 MendeleyKit has gone through a number of changes and improvements. Version 2 of the SDK is introducing a MendeleyKitiOS dynamic framework, including Swift 2.0 code. In addition to that some API additions were introduced (e.g. Mendeley features API enabling remote feature enabling).
Version 2 still supports MendeleyKit as a standalone static library for iOS and OSX. However, users of the SDK should be advised that the use of static library is deprecated and may be discontinued at a future release.
XCode 6.x iOS 7.x or higher
XCode 7 iOS 8 or higher OSX 10.9 or higher
The easiest way to include MendeleyKit in your project is to use cocoapods. In order to support both dynamic frameworks and legacy static library of MendeleyKit, we introduced separate Podspec files
- MendeleyKit.podspec: use this for static library of MendeleyKit (will not contain Swift code and some of the new APIs, such as analytics). Note this is deprecated and may be removed in future releases.
- MendeleyKitiOS.podspec - the iOS dynamic Framework. Requires iOS8 min and XCode 7
- MendeleyKitOSX.podspec - the OSX framework.
Use this in your Podfile:
use_frameworks!
pod 'MendeleyKitiOS', :git => 'https://github.com/Mendeley/mendeleykit.git'
Note: the framework supports both WebKit and UIWebView for login process (the latter is deprecated). To ensure you use the WebKit version of the Kit you may want to include the following lines in your Podfile:
post_install do |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'MendeleyKitiOSFramework']
#add any other build settings
end
end
end
(for cocoapods versions earlier than 0.38 use installer.project.targets.each instead of installer.pods_project.targets.each)
Note: Using use_frameworks! means that all included dependencies will be interpreted as frameworks. At this stage there is no provision in cocoapods to selectively mark some pods as frameworks and others as static library.
Once done do a
pod install
You can use the legacy static library of MendeleyKit using the MendeleyKit.podspec Note: the static library of MendeleyKit will not include any Swift classes - including the new MendeleyAnalytics classes/methods.
The Podfile in your project should include the following line
pod 'MendeleyKit', :git => 'https://github.com/Mendeley/mendeleykit.git'
From command line, simply do
pod install
For further information on Cocoapods see Cocoapods.
Alternatively, you may clone the public MendeleyKit from our github repository.
Using the MendeleyKitiOS framework means you will need to change your headers. All public headers in the MendeleyKit are included in the framework umbrella header MendeleyKitiOS.h. Please, replace all explicit MendeleyKit imports in your code with this one header.
#import <MendeleyKitiOS/MendeleyKitiOS.h>
You may want to use the more modern syntax
@import MendeleyKitiOS;
Note: If you are using the static library version of MendeleyKit you will need to use the following syntax (as the workspace has now modules enabled in the build sittings)
#import <MendeleyKit/MendeleyKit.h>
- client should have 'Enable modules' set to Yes
- MendeleyKit currently has bitcode disabled in its settings for backward compatibility reasons. You may need to do the same in the client using the MendeleyKit framework/lib.
MendeleyKit XCode workspace includes a MendeleyKitExample project. This demonstrates basic functionality such as authenticating with the Mendeley server, obtaining a list of documents, files and groups.
It is recommended to consult with the classes contained in the MendeleyKitExample project.
In addition the github repository includes a MendeleyKitHelp.zip file. This contains a complete reference set in HTML and Docset format.
When running the MendeleyKitExample app, please ensure you have
- client ID
- client secret key
- redirect URI
They need to be entered in the ViewController.h file. Note: code containing client IDs, client secrets, redirect URI will not be accepted in pull requests!
Mendeley API has links to create your app client id, key and redirect URIs.
Every client communicating with the server needs to be registered with the Mendeley developer portal Mendeley API.
Registration is quick, painless and free. It will give you the 3 essential ingredients you will need to supply when using the MendeleyKit in your app
- client ID
- client secret key
- redirect URI
These values need to match exactly the ones from the dev portal. The redirect URI should be a fully formed URL, such as - e.g. http://localhost/myredirect (rather than just 'localhost/myredirect). This avoids any pitfalls or 'Frame load interrupted' messages in the UIWebView kit.
This is an early-bird version of the MendeleyKit. We welcome your thoughts and suggestions. If you would like to make active contributions, e.g. code changes/additions,
- code submissions should only be made to Development branch via pull requests.
- you may create your own subbranches from Development and submit to it at will. However, if you want to merge it into Development then you would need to create a pull request
- Note: code containing client IDs, client secrets, redirect URI will not be accepted in pull requests!
All official releases of the MendeleyKit are tagged versions on master. Mendeley reserves the rights to merge changes made to Development into master. Each release will contain a RELEASE text file outlining changes made.
Please use the Issues feature on github to report any problems you encounter with the MendeleyKit. For feedback/suggestions please contact: api@mendeley.com