Python 3.x PDF library integration

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 x64Python 3.9 - 3.12 for Apple M1 (ARM processor)
• pip3Make sure python3 and pip3 are installed in your system. You can check your python version and pip3 version by using the command in terminal:

1python3 --version
2python3 -m pip --version

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

1brew install python3

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

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

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

or

1pip3 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:

1ERROR: Could not find a version that satisfies the requirement apryse-sdk (from versions: none)
2ERROR: 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:

1python3 --version

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

Download apryse-sdk Samples and unzip the package.

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:

1cd Samples/AddImageTest/PYTHON
2sh RunTest.sh

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

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

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

1PDFNet is running in demo mode.
2Permission: write
3Done. 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.

1cd Samples
2sh 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:

1# You can add the following line to integrate apryse-sdk
2# into your solution from anywhere on your system so long as
3# the library was installed successfully via pip
4
5from apryse_sdk import *
6
7def main():
8
9    # You need to initialize the PDFNet library
10    # Before calling any PDF related methods
11    PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")
12
13    # This example creates a new document
14    # and a new page, then adds the page
15    # in the page sequence of the document
16    doc = PDFDoc()
17
18    page1 = doc.PageCreate()
19    doc.PagePushBack(page1)
20
21    # We save the document in a linearized
22    # format which is the most popular and
23    # effective way to speed up viewing PDFs
24    doc.Save(("linearized_output.pdf"), SDFDoc.e_linearized)
25
26    doc.Close()
27
28if __name__ == "__main__":
29    main()

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

1python3 -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.

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

1ERROR: Could not find a version that satisfies the requirement apryse-sdk (from versions: none)
2ERROR: 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:

1python3 --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.

1. 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: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.

1python3 -m pip --version

1. 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:

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

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

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

1. 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.

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

Python3AWS Lambda Functions

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please fill out our licensing form if you do not have a valid license key.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Prerequisites

• Python 3.5 - 3.12Python 3.9 - 3.12 for ARM64
• pip3Make sure python3 and pip3 are installed in your system. You can check your python version and pip3 version by using the command in terminal:

sh

1python3 --version
2python3 -m pip --version

Report Invalid Code

Copy

If you need to install them, you can use the following commands:

sh

1sudo apt install python3 python3-pip

Report Invalid Code

Copy

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.

sh

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

Report Invalid Code

Copy

or

sh

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

Report Invalid Code

Copy

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

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

Text

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

Report Invalid Code

Copy

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

sh

1python3 --version

Report Invalid Code

Copy

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.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

The data that Apryse collects include:

• The names and number of API calls
• The number of pages in a document
• The version of the SDK
• The language of the SDK

For clarity, no other data is collected by the SDK and Apryse has no access to the contents of your documents.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run the Samples

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:

sh

1cd Samples/AddImageTest/PYTHON
2sh RunTest.sh

Report Invalid Code

Copy

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

sh

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

Report Invalid Code

Copy

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

sh

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

Report Invalid Code

Copy

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

Run all samples

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

sh

1cd Samples
2sh runall_python.sh

Report Invalid Code

Copy

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

Integrate into your application

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:

Python

1# You can add the following line to integrate apryse-sdk
2# into your solution from anywhere on your system so long as
3# the library was installed successfully via pip
4from apryse_sdk import *
5def main():
6    # You need to initialize the PDFNet library
7    # Before calling any PDF related methods
8    PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")
9    # This example creates a new document
10    # and a new page, then adds the page
11    # in the page sequence of the document
12    doc = PDFDoc()
13    page1 = doc.PageCreate()
14    doc.PagePushBack(page1)
15    # We save the document in a linearized
16    # format which is the most popular and
17    # effective way to speed up viewing PDFs
18    doc.Save(("linearized_output.pdf"), SDFDoc.e_linearized)
19    doc.Close()
20if __name__ == "__main__":
21    main()

Report Invalid Code

Copy

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

sh

1python3 -u HelloWorld.py

Report Invalid Code

Copy

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

Installing Additional Modules

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.

Next step

GuidesSamples

Troubleshooting

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

sh

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

Report Invalid Code

Copy

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

sh

1python3 --version

Report Invalid Code

Copy

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:

sh

1python3 -m pip --version

Report Invalid Code

Copy

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:

sh

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

Report Invalid Code

Copy

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

sh

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

Report Invalid Code

Copy

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.

This guide will help you set up Apryse SDK serverless AWS Lambda functions. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

• Python 3.6-3.11
• An active AWS account

Initial setup

In this particular guide, we will demonstrate how to set up an AWS Lambda function to use Apryse SDK.

First, prepare a zip package with apryse-sdk embedded and your lambda_function.py.

From the command line, check your Python3 version. This information will be needed when you create your function later.

sh

1python3 --version

Report Invalid Code

Copy

From the command line:

sh

1mkdir YOUR_FUNCTION_FOLDER
2cd YOUR_FUNCTION_FOLDER
3python3 -m pip install --target . apryse-sdk --extra-index-url=https://pypi.apryse.com

Report Invalid Code

Copy

Copy your lambda source (i.e. lambda_function.py) to YOUR_FUNCTION_FOLDER. Then zip your package before uploading it to your AWS Lambda account.

sh

1zip -r ./YOUR_FUNCTION_FOLDER.zip .

Report Invalid Code

Copy

You can now upload YOUR_FUNCTION_FOLDER.zip to your AWS Lambda.

Second, create a lambda function in your AWS account and upload the zip package:

• Lambda > Functions > Create function > Author from scratch > Function name [YOUR_FUNCTION_NAME] > Runtime [Python3.x] (Choose the version that matches your Python3 version from the checking above.) > choose Create Function
• Upload from .zip file > Upload [your zip package] > Save
• Add triger > API Gateway > Create an API > REST > Security [Open]
• Configuration > General configuration > Edit > memory [Choose 10240MB]

Integrate into your application

Once you have followed the initial setup instructions, you can begin calling Apryse SDK APIs in your lambda function source. For example:

Python

1from base64 import b64encode, b64decode
2import json
3from apryse_sdk import *
4def lambda_handler(event, context):
5    if event["httpMethod"] == "GET":
6        return {
7            'statusCode': 200,
8            'body': json.dumps('Hello from Apryse!')
9        }
10    elif event["httpMethod"] == "POST":
11        try:
12            body = json.loads(event["body"])
13            PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY") # if you use apryse-sdk 9.1.0 and above. Otherwise use PDFNet.Initialize()
14            # your AWS lambda function goes here
15            message = {
16                'statusCode': 200,
17                'headers': {'Content-Type': 'application/json'},
18                'body': json.dumps(base64_string),
19            }
20            return message
21        except Exception as e:
22            message = {
23                'statusCode': 500,
24                'body': e
25                }
26            return (message)

Report Invalid Code

Copy

Run Sample Code

You can update python script of your AWS Lambda function with the following code or download the source code from our github respository. This snippet shows how to process a request sent from a client to convert an office document to PDF and send the output to client.

Python

1# This example shows how to create AWS Lambda functions using Apryse SDK.
2# A REST API request was posted with base64 encoded data by the client.
3# The request would be processed by the server and a response with base64 encoded data of OfficeToPDF output would be sent to the client.
4from base64 import b64encode, b64decode
5import json
6from apryse_sdk import *
7def lambda_handler(event, context):
8    if event["httpMethod"] == "GET":
9        return {
10            'statusCode': 200,
11            'body': json.dumps('Hello, please send base64 doc to use this Lambda!')
12        }
13    elif event["httpMethod"] == "POST":
14        try:
15            body = json.loads(event["body"])
16            base64str = body["file"]["data"]
17            filename = body["file"]["filename"]
18            base64_bytes = b64decode(base64str)
19            # save input doc
20            output_path = '/tmp/'
21            input_filename = filename.split('.')[0] + '.docx'
22            with open(output_path + input_filename, 'wb') as open_file:
23                byte_content = open_file.write(base64_bytes)
24            # Start with a PDFDoc
25            PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY") # if you use apryse-sdk 9.1.0 and above. Otherwise use PDFNet.Initialize()
26            pdfdoc = PDFDoc()
27            # perform the conversion with no optional parameters and save to /temp
28            Convert.OfficeToPDF(pdfdoc, output_path + input_filename, None)
29            # save the result
30            output_filename = filename.split('.')[0] + '.pdf'
31            pdfdoc.Save(output_path + output_filename, SDFDoc.e_linearized)
32            # sending data
33            with open(output_path + output_filename, 'rb') as open_file:
34                byte_content = open_file.read()
35            base64_bytes = b64encode(byte_content)
36            base64_string = base64_bytes.decode('utf-8')
37            print("Sending " + output_filename )
38            message = {
39                'statusCode': 200,
40                'headers': {'Content-Type': 'application/json'},
41                'body': json.dumps(base64_string),
42            }
43            return message
44        except Exception as e:
45            print(e)
46            message = {
47                'statusCode': 500,
48                'body': e
49                }
50            return (message)

Report Invalid Code

Copy

Testing

After you have uploaded your zip package to your AWS Lambda function and get its API endpoint in Configuration > Triggers, you can now do a simple test using REST API.

In order to use this function to convert an office document to PDF, the client needs to post a REST API request to the server. The request must include json data structured as in the code below.

Python

1json_data = {
2            "file": {
3                "encoding": "base64",
4                "data": base64_string_of_your_office_document,
5                "filename": filename,
6                "content-type": "application/pdf"
7            }
8        }

Report Invalid Code

Copy

Upon receiving a client's request, a response will be sent back to the client including the base64 encoded pdf output using the same json structure. All the client needs to do now is decode the encoded data into pdf. That's it!
Access the sample python code. After cloning the repository and installing necessary packages, please refer to /client/README.txt for detailed instructions. Navigate to the client folder, run the following command, and see the reponse to client's request in the console and check the output in the output folder:

sh

1python AWSLambdaExample.py --url <YOUR PUBLISHED FUNCTION URL>

Report Invalid Code

Copy

The client will send a REST API request to convert /input/simple-word_2007.docx to pdf and the server will send back the encoded data, which will then be saved as pdf in the output folder.

You can experiment with your own office document by putting it inside input folder:

sh

1python AWSLambdaExample.py --url <YOUR PUBLISHED FUNCTION URL> --filename <YOUR OFFICE FILENAME>

Report Invalid Code

Copy

We have shown how to set an AWS Lambda function using Apryse SDK. You can now experiment making your own functions, URLs, and can fully utilize Apryse SDK. If your have any questions, please don't hesitate to contact us!