Some test text!
Welcome to PDFTron. Python3 for the PDFTron SDK is supported on Windows, Linux and macOS and has precompiled wrappers available. To get started, choose your preferred platform from the tabs below.
This guide will help you run PDFTron samples and integrate a free trial of the PDFTron SDK into Python applications on Windows. Your free trial includes unlimited trial usage and support from solution engineers.
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
pip3 to install
PDFNetPython3 library from Python Package Index (PyPI) in terminal.
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
python3 -m pip install PDFNetPython3
pip3 install PDFNetPython3
If no errors occur,
Successfully installed PDFNetPython3 ... will display in terminal.
Get your PDFTron trial key.
Find and enter the
Run a specific sample
Find the sample you want to run and navigate into the
PYTHON folder inside.
RunTest.sh and use the following commands to run it in terminal:
cd PDFNetPython3/Samples/AddImageTest/PYTHON sh RunTest.sh
Alternatively, you can use the following commands to run
cd PDFNetPython3/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
Run all samples
runall_python.sh in the samples folder and run it.
cd PDFNetPython3/Samples sh runall_python.sh
The output files from all tests are stored in
It is easy to integrate PDFNetPython3 into your application. After you have installed
PDFNetPython3 via pip, all you need to do is add
from PDFNetPython3 import * to your Python script.
Below is an example called
# You can add the following line to integrate PDFNetPython3 # into your solution from anywhere on your system so long as # the library was installed successfully via pip from PDFNetPython3 import * def main(): # You need to initialize the PDFNet library # Before calling any PDF related methods PDFNet.Initialize() # 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
CADTest samples, which can be downloaded here .
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.
If you successfully install our
PDFNetPython3 library via pip but run into errors when running a sample, it may be that your Python version is not fully compatible.
You can check your python version by using the command:
and update your Python to the recommended versions. If errors still occur, please contact our support team.
If you cannot install
PDFNetPython3 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.9, it may be that no precompiled PDFnetPython3 library is compatible with your system. Please contact our support team. You might need to build your own PDFNetPython3 wrapper using SWIG and our PDFNetC library.
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
PDFNetPython3, 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 ```
If you want to upgrade
PDFNetPython3 to the latest version, you can simply run:
python3 -m pip install PDFNetPython3 --upgrade
If you run a sample and get the output:
You will need to install
PDFNetPython3 via pip first before you could run the sample.
Get the answers you need: Support