Integrating PSPDFKit Using CocoaPods

PSPDFKit is available via CocoaPods. We provide a private URL for the Podspec so that you can integrate PSPDFKit with minimum effort, either pinning to a specific version or always getting the latest stable release. If you’re new to CocoaPods, our Getting Started guide will help you.

ℹ️ Note: Please don’t follow our manual integration guide if you’re using CocoaPods. Using strip-framework.sh together with CocoaPods won’t work.

Important: Please make sure that you have a CocoaPods version >= 1.4.0 installed. You can check your version of CocoaPods with pod --version.

Read on to see what you have to add to your Podfile.

Always Use the Latest Release:

1
2
3
4
5
6
7
8

use_frameworks!

target :YourTargetName do
  pod 'PSPDFKit',
      podspec:
        'https://customers.pspdfkit.com/cocoapods/YOUR_COCOAPODS_KEY_GOES_HERE/latest.podspec'
  platform :osx, '10.12'
end

Pinning to a Specific Version (e.g. 1.0.2):

1
2
3
4
5
6
7
8

use_frameworks!

target :YourTargetName do
  pod 'PSPDFKit',
      podspec:
        'https://customers.pspdfkit.com/cocoapods/YOUR_COCOAPODS_KEY_GOES_HERE/1.0.2.podspec'
  platform :osx, '10.12'
end

Once you’ve completed the steps above, run pod install. Try the demo to get started on the integration.

Where Do I Find the Podspec URL Key?

If you are a customer, you can find your custom URL in your customer portal by choosing the Use CocoaPods tab when downloading PSPDFKit. If you are a new customer, you can get a demo Podspec URL by clicking on the trial button on our website. If you would like to purchase a license, please contact our sales team with your use case and the features you would like.

To manually integrate PSPDFKit, see Integrating PSPDFKit Manually.

Use Nightly Test Builds

If you have an active license subscription, we can enable access to nightlies on CocoaPods. Once that is done, replace latest.podspec with nightly.podspec to point to the latest nightly build.

Use a JSON Podspec

CocoaPods makes a checksum of the JSON representation of your Podspec and keeps it in your Podfile.lock file. If your development environment requires you to use a JSON Podspec, you can append .json to your CocoaPods URL, like so:

1
2
3
4
5
6
7
8

use_frameworks!

target :YourTargetName do
  pod 'PSPDFKit',
      podspec:
        'https://customers.pspdfkit.com/cocoapods/YOUR_COCOAPODS_KEY_GOES_HERE/latest.podspec.json'
  platform :osx, '10.12'
end

To learn more about Podspec checksums, please take a look at the Why does my team’s Podfile.lock Podspec checksums change? blog post.