Get Started with the Apryse Server SDK Python 3 PDF Library Integration

Before you start:

• Install Visual Studio Code (or your preferred application) to write, edit, and debug source code.
• Get your Apryse trial key.

You’ll need Python 3 on your system. You’ll need pip3 to eventually install the Apryse Server SDK.

1. Check to see if Python 3 and pip3 are installed on your system:

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

2. Complete one of the following based on whether pip3 and Python3 are already installed:

• OPTION 1: Install Python 3 and pip3 if they’re not installed.
  • To download Python 3, go to the Python home page, hover over Downloads at the top of the page, then select the file you need based on your operating system and device processor. You can use any Python 3 version that’s supported.
  • To install pip3 from the command line:
    • Install pip3 to your package lists:

1sudo apt update 

• Enable the universe repository, if not already enabled:

1sudo add-apt-repository universe 
2sudo apt update 

• Install pip3:

1sudo apt install python3-pip 

• OPTION 2: Update Python 3 and pip3 if there are versions already installed on your device:
  • Add the following to the command line:

1sudo apt install python3 python3-pip

You’ll download and run the OfficeToPDFTest sample which allows you to explore and validate the conversion features offered by the SDK. By running the sample, you can quickly:

•  Verify the capabilities.
• Understand how to interact with the MS Office to Conversion PDF API.
• Use it as a reference for integrating similar functionality into your own application.

1. Download the tarball file for Linux file which includes all of the Apryse samples.
2. Use your Linux file explorer to navigate to the Downloads folder, right-click on the tar.gz tarball file, then select Extract to...
3. Select Home, New Folder, then enter ApryseSamples, and click Create to create a new folder to extract the tarball file into for running the samples. You can create a folder at a different location if you prefer, but for this guide’s instructions, we used the location and name above.
4. Select the new folder you created, then click the Select button to cause the file to extract to your new folder.

The ApryseSamples folder is created and the tarball is extracted to the folder.

5. Navigate to the folder /Home/ApryseSamples/PDFNetPython3/Samples/OfficeToPDFTest/Python, right-click on the Python folder, then select Open in Terminal.

6. The Linux terminal opens to the directory you specified. On the command line, enter the following, then press Enter to install the apryse-sdk library from Apryse’s S3 private repository (You need this to run samples successfully):

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

or

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

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

7. Navigate via your Linux file explorer to /Home/ApryseSamples/PDFNetPython3/Samples/LicenseKey/Python/LicenseKey.py and double-click to open so you can add your license key to the LicenseKey.py file before running the sample.

8. Scroll down to the line containing ‘LicenseKey = “YOUR_PDFTRON_LICENSE_KEY” and replace the words in quotes with the copy of your trial license key. Leave the ‘if LicenseKey ==YOUR_PDFTRON_LICENSE_KEY’ as is with its default text.

9. Save your changes and close the file.

10. To run the sample, navigate, through the Linux file explorer, to /Home/ApryseSamples/PDFNetPython3/Samples/OfficeToPDFTest/Python, right-click on the Python folder, then select Open in Terminal.

11. The Linux terminal opens the OfficeToPDFTest sample. From the project directory, on the command line, enter the following, then press Enter:

1sh RunTest.sh

When you run the sh RunTest.sh command, the sample code loads an Office document, converts the Office document to PDF, saves the resulting PDF, and outputs status messages to the console. For more details, you can look at additional OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

Once the sample finishes running, you'll see the status Done in the terminal.

12. At the command prompt, type Exit, then press Enter.

13. Go to your Linux file explorer and navigate to: /Home/ApryseSamples/PDFNetPython3/Samples/TestFiles/Output. You will see three output PDF files (Fisherman.pdf, the_rime_of_the_ancient_mariner.pdf, and the factsheet_Arabic.pdf).

14. Open the PDF files to see the converted output. You have successfully run the OfficeToPDFTest conversion sample!

Next, you’ll create your own Python 3 project and add the Apryse Server SDK so you can later integrate the Apryse Server SDK into the project and run it.

1. In your Linux file explorer, navigate to the Home folder, and select New Folder. Alternatively, press CTRL + Shift + n to display the New Folder modal.
2. Enter the folder name, NewApryseProject, then click Create.
3. Navigate to the folder /Home/NewApryseProject, right-click on the folder, then select Open in Terminal.
4. The Linux terminal opens to the directory you specified. On the command line, enter the following, then press Enter to install the apryse-sdk library from Apryse’s S3 private repository (You need this to run your project successfully):

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

or

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

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

Next, you’ll open a blank PDF page within your application.

1. Open Visual Studio Code (or your preferred application) and from the File menu, select Open Folder.
2. Navigate to the Home folder from Linux file explorer, then, select the NewApryseProject folder and click Open.

The NewApryseProject opens in Visual Studio Code.

3. Create a file in the project named HelloWorld.py.

4. Copy the following Python code and paste it into Line 1 of the HelloWorld.py file, then Save your file.

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("demo:1763580498695:601269ef03000000007505554501519c80287620321ec3184e959426e1")
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()

Keep in mind the following about the code above:

• You’re importing the Apryse SDK.
• You’re initializing PDFNet using your Apryse license key. Scroll down to the line containing PDFNet.Initialize(“YOUR_LICENSE_KEY”); and replace the words in quotes with the copy of your trial license key. If you’re logged in to Apryse.com, your license key will automatically replace YOUR_LICENSE_KEY in the code above.
• You’re doing various work with PDFNet. In this case, with a PDFDoc object.
• You’re calling PDF.Terminate which releases any resources in use.

5. To test that your code works, run the script in the folder containing HelloWorld.py in the command prompt, then press Enter.

1python3 -u HelloWorld.py 

The code executes and you will see PDFNet is running in demo mode.

6. Exit out of the command line and navigate to the Home/NewApryseProject folder from Linux file explorer.

7. Open the linearized_output.pdf which you created by integrating the Apryse Server SDK!

8. Now that you have successfully run an OfficeToPDFTest sample and integrated the Apryse Server SDK Python PDF Library into your application, you can try out 50+ samples depending on your needs.

9. To try additional samples, go to section 2. Run a sample > Step 5 above and choose a different sample to run with a different URL path.