Custom Python wrapper for 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.

• Python3 or Python2 with developer extensions
• CMake version ≥ 2.8
• SWIG 2.0.4 - 2.0.12 or SWIG 3.0.12 or SWIG 4.0.2 and above
• Apryse's Python3 PDF library for macOS:

1. Make a directory to store the wrappers and navigate into that directory.
2. Clone the uncompiled PDFNet wrappers project by executing

1git clone https://github.com/PDFTron/PDFNetWrappers

1. Navigate to PDFNetWrappers/PDFNetC and move the downloaded [PDFNet C/C++ SDK] for macOS(#prerequisites) into that directory and unzip it. Ensure you obtain the right architecture for your Python interpreter. This can be done with these two commands:

1curl -L -O http://www.pdftron.com/downloads/PDFNetCMac.zip
2unzip PDFNetCMac.zip

1. Now to move the headers in place, make sure you are in the PDFNetWrappers/PDFNetC directory and executeandto move the PDFNet libraries in place.You can delete PDFNetCMac.zip to free up space.Your /PDFNetC folder should be laid out like this like this:

1mv PDFNetCMac/Headers/ .

1mv PDFNetCMac/Lib/ .

1PDFNetC
2├── Headers
3├── Lib
4├── PDFNetCMac
5└── README.txt

1. Make a build directory inside /PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.
2. ExecuteIf all goes well, you should get a message which reads:

1cmake -D BUILD_PDFNetPython=ON ..

1Build files have been written to ~/PDFNetWrappers/Build

1. Execute make followed by sudo make install.
2. Next we need to fix the rpaths issue on Mac. While still in the same Build directory, execute these lines:

1cp ../fix_rpaths.sh ../PDFNetC/Lib/
2cd ../PDFNetC/Lib/
3sudo sh ./fix_rpaths.sh

1. Get your Apryse trial key.

You are now ready to run the samples or integrate Apryse SDK into your own application.

Running a specific sample

1. Navigate to the PYTHON folder in the sample, for example /Samples/AddImageTest/PYTHON and execute ./RunTest.sh.

Run all samples

1. To run all tests, navigate to /Samples and executeThe tests will run one by one.

1./runall_python.sh

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

1. Navigate to the /Samples directory and create a new directory called myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside myApp called PYTHON.
2. Navigate inside that PYTHON directory and create a new Python file called myApp.py. Open it with your favorite text editor and paste this into it:

1import site
2# below is the relative path to Apryse PDFNetC libraries
3site.addsitedir("../../../PDFNetC/Lib")
4import sys
5from PDFNetPython import *
6
7def main():
8    PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")
9    doc = PDFDoc()
10    page = doc.PageCreate()         # Start a new page
11    doc.PagePushBack(page)          # Add the page to the document
12    doc.Save("output.pdf", SDFDoc.e_linearized);  # Save the document as a linearized PDF
13    print("Hello World!")
14
15if __name__ == '__main__':
16    main()

1. Run your application via python myApp.py. If all goes well your output should read:

1PDFNet is running in demo mode.
2Permission: write
3Hello World!

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Check the troubleshooting page and our PDFNetWrappers github if you run into any issues going through this document.

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

• Python 2.7 or 3.x.Make sure the executable name is python.exe
• cmake >= 2.8.
• SWIG 2.0.4 - 2.0.12 OR SWIG 3.0.12 OR SWIG 4.0.2 and above.
• Visual Studio.
• Download the PDFNet Wrapper files or clone the repository:If you downloaded, extract the PDFNetWrappers-master folder.

1git clone https://github.com/PDFTron/PDFNetWrappers.git

• Apryse's Python PDF library for Windows:

Make sure Python, cmake and SWIG are all added to your path environment variable.

1. Extract the PDFNetWrappersWinXX folder from the .zip file. This guide will assume it has been extracted to the current user's Desktop.

2. From the extracted folder, copy the Lib and Headers folders and paste them into PDFNetWrappers-master/PDFNetC/

3. Create a new folder called Build inside the PDFNetWrappers folder and enter it.This is what the current directory structure should look like:

4. Open a Command Prompt here and run the following:

1cmake -D BUILD_PDFNetPython=ON ..

This will choose a default Visual Studio version to build the projects for. Wait for the bindings to finish. The output should end with something like this:

1-- Build files have been written to: C:/Users/User_Name/Desktop/PDFNetWrappers-master/Build

If you see error messages during this process, see the Troubleshooting section.You should have the following files in your Build directory:

5. Open the generated PDFNetLanguageBindings.sln with Visual Studio.

6. Change the build mode from Debug to Release, make sure the appropriate target version (x86 or x64) is selected and build the solution.

7. When using the PDFNetC64 (64-bit) library files then change the build configuration to x64 in the Build dropdown by choosing Configuration Manager....Under Active Solution Platform, Select <New...> and choose x64 if x64 is not displayed as a platform.Click ok then close the modal to exit.

8. Right-click project PDFNetPython within Solution Explorer and choose Properties.Under Linker, select Command Line and change X86 to X64.Click ok to exit the modal.

9. Right-click and build the PDFNetPython project.This will build the Python library files.

10. Copy the _PDFNetPython.pyd dynamic link library file to the build\lib\Release folder using the command line below or manually from Windows explorer.This will ensure the Python module which communicates through the dynamic link library can be located for installation.

1copy ".\x64\Release\_PDFNetPython.pyd" ".\lib\Release"

11. When this is done, select and build the INSTALL project.This will install PDFNetPython lib files to the PDFNetWrappers\PDFNetC\lib folder where it can be located by the samples.

12. Get your Apryse trial key.

The bindings should be successfully built. You can now run the samples to test out the Apryse SDK.

Find and enter the Samples folder (PDFNetWrappers-master/Samples). Here you can find sample code for a large number of features supported by the Apryse SDK.

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

Run a specific sample

1. Find the sample you want to run and navigate into the PYTHON folder inside.
2. Find RunTest.bat and run it. The results should appear on a cmd window.

Run all samples

1. Find runall_python.bat in the samples folder and double click on it to run it. The results should appear on a cmd window.

Press any key when a sample ends to start the next one.

This is what we call the "Apryse Hello World" application. It is easy to integrate the rest of Apryse SDK if you are able to open, save and close a PDFDoc.

1. Create a new folder in Samples by the name HelloWorld.
2. In the HelloWorld folder, create a new file called HelloWorld.py, open and edit it using your favorite text editor.
3. Insert the following to your file:To test that your code works, run the code using a shell in the HelloWorld folder using:Once you have successfully run this, you should see an output file in the working directory of this program.

1# You can use the following two lines to use PDFNetPython
2# in your solution from anywhere on your system
3# so long as you have relative path
4import site
5site.addsitedir("../../Lib")
6import sys
7
8# This is the most important packages to import
9# for basic document manipulation.
10from PDFNetPython import *
11
12def main():
13
14    # You need to initialize the PDFNet library
15    # Before calling any PDF related methods
16    PDFNet.Initialize("YOUR_APRYSE_LICENSE_KEY")
17
18    # This example creates a new document
19    # and a new page, then adds the page
20    # in the page sequence of the document
21    doc = PDFDoc()
22
23    page1 = doc.PageCreate()
24    doc.PagePushBack(page1)
25
26    # We save the document in a linearized
27    # format which is the most popular and
28    # effective way to speed up viewing PDFs
29    doc.Save(("linearized_output.pdf"), SDFDoc.e_linearized)
30
31    doc.Close()
32
33if __name__ == "__main__":
34    main()

1python.exe -u HelloWorld.py

Multiple versions of Python
More information for conflict resolution between multiple Python installations.

CMake Process finding incorrect version
Setting specific versions of Python to use for cmake.