Platforms
Frameworks
Languages
Platform Specifics
File format support
Welcome to Apryse. Ruby for the Apryse SDK is supported on Linux and macOS. To get started, choose your preferred platform from the tabs below.
There are two ways to use Apryse with Ruby on macOS:
To get started, please choose a tab below.
This guide will help you get started using the precompiled Ruby wrappers. You can run Apryse samples and integrate a free trial of the Apryse SDK into Ruby application on macOS. Your free trial includes unlimited trial usage and support from solution engineers.
Download SDK
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.
License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).
1. Download the Python and Ruby prebuilt binaries.
2. Extract the downloaded zip file and navigate to it.
3. Navigate to the /PDFNetC/Lib
directory of the Python SDK download and execute:
4. Get your Apryse trial key.
Run a specific sample
1. Navigate to the RUBY
folder in the sample, for example /Samples/RUBY
and execute ./RunTest.sh
.
Run all samples
1. To run all tests, navigate to /Samples
and execute the runall_ruby
file:
The tests will run one by one.
Output files will be in /Samples/TestFiles/Output
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 your /Samples
directory and make 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 RUBY
.
2. Navigate inside that RUBY
folder and create a new Ruby file called myApp.rb
. Open it with your favorite text editor and paste this into it:
Run your application by executing ruby myApp.rb
. If all goes well, your console should output:
Check the output.pdf
that the program output in the same directory. It should be a PDF with one blank page.
This guide will help you build your own PDFNet Ruby wrappers by binding a free trial of the PDFNetC library to Ruby. It will also show you how to run Apryse samples and integrate the Apryse SDK into Ruby applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.
Download the SDK
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.
License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).
1. Make a directory to store the wrappers and navigate into that directory.
2. Clone the uncompiled PDFNet wrappers by executing
3. 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 Ruby interpreter. This can be done with these two commands:
4. Now to move the headers in place, make sure you are in the PDFNetWrappers/PDFNetC
directory and execute
and
to 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:
5. Make a build directory inside /PDFNetWrappers
and navigate to it. This guide will assume the build directory is called Build.
6. Execute
If all goes well, you should get a message which reads:
7. Execute make
followed by sudo make install
.
8. Next we need to fix the rpaths
issue on Mac. While still in the same Build
directory, execute these lines:
9. Get your Apryse trial key.
You are now ready to run the samples or integrate Apryse SDK into your own application.
Run a specific sample
1. Navigate to the RUBY
folder in the sample, for example /Samples/AddImageTest/RUBY
and execute ./RunTest.sh
Run all Samples
1. Navigate to /Samples
and execute:
The tests will run one by one.
Output files will be in /Samples/TestFiles/Output
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 your /Samples
directory and make 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 RUBY
.
2. Navigate inside that RUBY
folder and create a new Ruby file called myApp.rb
. Open it with your favorite text editor and paste this into it:
Run your application by executing ruby myApp.rb
. If all goes well, your console should output:
Check the output.pdf
that the program output in the same directory. It should be a PDF with one blank page.
This guide will help you build your own PDFNet Ruby wrappers by binding a free trial of the PDFNetC library to Ruby. It will also show you how to run Apryse samples and integrate the Apryse SDK into Ruby applications on Linux. Your free trial includes unlimited trial usage and support from solution engineers.
Download the SDK
Download the SDK
A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.
License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).
PDFNetWrappers/PDFNetC
and download the PDFNet C/C++ SDK into that directory. Ensure you obtain the right architecture for your Ruby interpreter. For example, if your interpreter is 64bit (which this guide will assume), executePDFNetC64.tar.gz
via tar xvzf PDFNetC64.tar.gz
, then executeandto move the PDFNet libraries in place.You can delete PDFNetC64.tar.gz
to free up space.Your /PDFNetC
folder should be laid out like this like this:/PDFNetWrappers
and navigate to it. This guide will assume the build directory is called Build.make
followed by sudo make install
. You are now ready to run the samples or integrate Apryse SDK into your own application.Run a specific sample
RUBY
folder in the sample, for example /Samples/AddImageTest/RUBY
and execute ./RunTest.sh
Run all samples
/Samples
and execute:The tests will run one by one.
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.
/Samples
directory and make 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 RUBY
.RUBY
folder and create a new Ruby file called myApp.rb
. Open it with your favorite text editor and paste this into it:Run your application by executing ruby myApp.rb
. If all goes well, your console should output: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.
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales