This guide will help you run Apryse samples and integrate a free trial of the Apryse SDK into Python applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

• Python 3.5 - 3.12 for x64

  Python 3.9 - 3.12 for Apple M1 (ARM processor)

• pip3

  Make sure python3 and pip3 are installed in your system. You can check your python version and pip3 version by using the command in terminal:

python3 --version
python3 -m pip --version

You can install python3 and pip3 with Homebrew using the following command:

brew install python3

There are THREE steps needed before you can use apryse-sdk library.

Step 1

Use pip3 to install apryse-sdk library from Apryse's S3 private repository in terminal. Notice that PDFNetPython3 library from Python Package Index (PyPI) will no longer be updated in the future after the 9.5.0 release.

We recommend running this in a virtual environment, to guarantee the location of where our library will be installed. Henceforth, if our library needs to be imported, be sure to activate the same virtual environment before running a Python script that imports from apryse-sdk

python3 -m pip install apryse-sdk --extra-index-url=https://pypi.apryse.com

or

pip3 install apryse-sdk --extra-index-url=https://pypi.apryse.com

If no errors occur, Successfully installed apryse-sdk ... will display in terminal.

If you run into this error when installing apryse-sdk via pip:

ERROR: Could not find a version that satisfies the requirement apryse-sdk (from versions: none)
ERROR: No matching distribution found for apryse-sdk

It is possible that your Python version is NOT fully compatible. You can check your python version by using the command:

python3 --version

and make sure your Python version is within 3.5 - 3.11.

Step 2

Download apryse-sdk Samples and unzip the package.
Download apryse-sdk Samples

Step 3

Get your Apryse trial key.

Navigate to the Samples folder. Notice that you will need to update Samples/LicenseKey/PYTHON/LicenseKey.py before you could run Samples.

Run a specific sample

1. Find the sample you want to run and navigate into the PYTHON folder inside.

2. Find RunTest.sh and use the following commands to run it in terminal:

cd Samples/AddImageTest/PYTHON
sh RunTest.sh

Alternatively, you can use the following commands to run AddImageTest:

cd Samples/AddImageTest/PYTHON
python3 -u AddImageTest.py

If no errors occur, the following lines will display in terminal:

PDFNet is running in demo mode.
Permission: write
Done. Result saved in addimage.pdf...

The output files are stored in Samples/TestFiles/output/

Run all samples

1. Find runall_python.sh in the samples folder and run it.

cd Samples
sh runall_python.sh

The output files from all tests are stored in Samples/TestFiles/output/.

It is easy to integrate apryse-sdk into your application. After you have installed apryse-sdk via pip, all you need to do is add from apryse_sdk import * to your Python script.

Below is an example called HelloWorld.py:

# You can add the following line to integrate apryse-sdk
# into your solution from anywhere on your system so long as
# the library was installed successfully via pip

from apryse_sdk import *

def main():

    # You need to initialize the PDFNet library
    # Before calling any PDF related methods
    PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")

    # This example creates a new document
    # and a new page, then adds the page
    # in the page sequence of the document
    doc = PDFDoc()

    page1 = doc.PageCreate()
    doc.PagePushBack(page1)

    # We save the document in a linearized
    # format which is the most popular and
    # effective way to speed up viewing PDFs
    doc.Save(("linearized_output.pdf"), SDFDoc.e_linearized)

    doc.Close()

if __name__ == "__main__":
    main()

To test that your code works, run the script in the folder containing HelloWorld.py in command prompt:

python3 -u HelloWorld.py

Once you have successfully run this, you should see an output file in the working directory of this program.

Additional modules are required to run our OCRTest or CADTest samples, which can be accessed on our additional module downloads page.

Be sure to merge the Samples/ directory from the module into the Samples/ directory obtained from the download in Step 2, ensuring that the files the sample code depends on are available.

Guides Samples

1. If you run into this error when installing apryse-sdk via pip:

ERROR: Could not find a version that satisfies the requirement apryse-sdk (from versions: none)
ERROR: No matching distribution found for apryse-sdk

It is possible that your Python version is NOT fully compatible. You can check your python version by using the command:

python3 --version

and make sure your Python version is within 3.5 - 3.11.

We recommend using Python 3.5.4, 3.6.8, 3.7.9, 3.8.5, 3.9.6, 3.10.4 to guarantee 100% compatibility.

If errors still occur, please contact our support team.

2. If you cannot install apryse-sdk library via pip, you need to check whether python3 and pip3 are installed in your system.

   You can test it by using the following command:

   python3 -m pip --version

   If no errors occur and your python version is within 3.5 - 3.11, it may be that no precompiled apryse-sdk library is compatible with your system. Please contact our support team. You might need to build your own apryse-sdk wrapper using SWIG and our PDFNetC library.

3. If you are running into issues with compatibility with other libraries, we recommend using our library in a virtual environment, to guarantee the location of where our library will be installed. Henceforth, if our library needs to be imported, be sure to activate the same virtual environment before running a Python script that imports from apryse-sdk, as follows:

# Creates a venv/ folder in your current directory
python3 -m venv venv
# Activate the virtual environment in the current terminal session
source venv/bin/activate

4. If you want to upgrade apryse-sdk to the latest version, you can simply run:

   python3 -m pip install apryse-sdk --upgrade --extra-index-url=https://pypi.apryse.com

5. If you run a sample and get the output:

You will need to install apryse-sdk via pip first before you could run the sample.