github.com/unidoc/unipdf/v3@v3.55.0/README.md (about)

     1  # UniPDF - PDF for Go
     2  
     3  [UniDoc](http://unidoc.io) UniPDF is a PDF library for Go (golang) with capabilities for
     4  creating and reading, processing PDF files. The library is written and supported by 
     5  [FoxyUtils.com](https://foxyutils.com), where the library is used to power many of its services. 
     6  
     7  [![GitHub (pre-)release](https://img.shields.io/github/release/unidoc/unipdf/all.svg)](https://github.com/unidoc/unipdf/releases)
     8  [![License: UniDoc EULA](https://img.shields.io/badge/license-UniDoc%20EULA-blue)](https://unidoc.io/eula/)
     9  [![ApiDocs](https://img.shields.io/badge/godoc-reference-blue.svg)](https://apidocs.unidoc.io/unipdf/latest/)
    10  
    11  ## Features
    12  
    13  - [Create PDF reports](https://github.com/unidoc/unipdf-examples/blob/master/report/pdf_report.go). Example output: [unidoc-report.pdf](https://github.com/unidoc/unipdf-examples/blob/master/report/unidoc-report.pdf).
    14  - [Table PDF reports](https://github.com/unidoc/unipdf-examples/blob/master/report/pdf_tables.go). Example output: [unipdf-tables.pdf](https://github.com/unidoc/unipdf-examples/blob/master/report/unipdf-tables.pdf).
    15  - [Invoice creation](https://unidoc.io/news/simple-invoices)
    16  - [Styled paragraphs](https://github.com/unidoc/unipdf-examples/blob/master/report/pdf_formatted_text.go)
    17  - [Merge PDF pages](https://github.com/unidoc/unipdf-examples/blob/master/pages/pdf_merge.go)
    18  - [Split PDF pages](https://github.com/unidoc/unipdf-examples/blob/master/pages/pdf_split.go) and change page order
    19  - [Rotate pages](https://github.com/unidoc/unipdf-examples/blob/master/pages/pdf_rotate.go)
    20  - [Extract text from PDF files](https://github.com/unidoc/unipdf-examples/blob/master/extract/pdf_extract_text.go)
    21  - [Text extraction support with size, position and formatting info](https://github.com/unidoc/unipdf-examples/blob/master/text/pdf_text_locations.go)
    22  - [PDF to CSV](https://github.com/unidoc/unipdf-examples/blob/master/text/pdf_to_csv.go) illustrates extracting tabular data from PDF.
    23  - [Extract images](https://github.com/unidoc/unipdf-examples/blob/master/extract/pdf_extract_images.go) with coordinates
    24  - [Images to PDF](https://github.com/unidoc/unipdf-examples/blob/master/image/pdf_images_to_pdf.go)
    25  - [Add images to pages](https://github.com/unidoc/unipdf-examples/blob/master/image/pdf_add_image_to_page.go)
    26  - [Compress and optimize PDF](https://github.com/unidoc/unipdf-examples/blob/master/compress/pdf_optimize.go)
    27  - [Watermark PDF files](https://github.com/unidoc/unipdf-examples/blob/master/image/pdf_watermark_image.go)
    28  - Advanced page manipulation:  [Put 4 pages on 1](https://github.com/unidoc/unipdf-examples/blob/master/pages/pdf_4up.go)
    29  - Load PDF templates and modify
    30  - [Form creation](https://github.com/unidoc/unipdf-examples/blob/master/forms/pdf_form_add.go)
    31  - [Fill and flatten forms](https://github.com/unidoc/unipdf-examples/blob/master/forms/pdf_form_flatten.go)
    32  - [Fill out forms](https://github.com/unidoc/unipdf-examples/blob/master/forms/pdf_form_fill_json.go) and [FDF merging](https://github.com/unidoc/unipdf-examples/blob/master/forms/pdf_form_fill_fdf_merge.go)
    33  - [Unlock PDF files / remove password](https://github.com/unidoc/unipdf-examples/blob/master/security/pdf_unlock.go)
    34  - [Protect PDF files with a password](https://github.com/unidoc/unipdf-examples/blob/master/security/pdf_protect.go)
    35  - [Digital signing validation and signing](https://github.com/unidoc/unipdf-examples/tree/master/signatures)
    36  - CCITTFaxDecode decoding and encoding support
    37  - JBIG2 decoding support
    38  
    39  Multiple examples are provided in our example repository https://github.com/unidoc/unipdf-examples.
    40  
    41  Contact us if you need any specific examples.
    42  
    43  ## Installation
    44  With modules:
    45  ~~~
    46  go get github.com/unidoc/unipdf/v3
    47  ~~~
    48  
    49  ## License key
    50  This software package (unipdf) is a commercial product and requires a license code to operate.
    51  
    52  To Get a Metered License API Key in for free in the Free Tier, sign up on https://cloud.unidoc.io
    53  
    54  
    55  ## How can I convince myself and my boss to buy unipdf rather using a free alternative?
    56  
    57  The choice is yours. There are multiple respectable efforts out there that can do many useful things.
    58  
    59  In UniDoc, we work hard to provide production quality builds taking every detail into consideration and providing excellent support to our customers.  See our [testimonials](https://unidoc.io) for example.
    60  
    61  Security.  We take security very seriously and we restrict access to github.com/unidoc/unipdf repository with protected branches and only the founders have access and every commit is reviewed prior to being accepted.
    62  
    63  The profits are invested back into making unipdf better. We want to make the best possible product and in order to do that we need the best people to contribute. A large fraction of the profits made goes back into developing unipdf.  That way we have been able to get many excellent people to work and contribute to unipdf that would not be able to contribute their work for free.
    64  
    65  
    66  ## Contributing
    67  
    68  If you are interested in contributing, please contact us.
    69  
    70  ## Go Version Compatibility
    71  
    72  Officially we support three latest Go versions, but internally we would test the build with up to five latest Go versions in our CI runner.
    73  
    74  ## Support and consulting
    75  
    76  Please email us at support@unidoc.io for any queries.
    77  
    78  If you have any specific tasks that need to be done, we offer consulting in certain cases.
    79  Please contact us with a brief summary of what you need and we will get back to you with a quote, if appropriate.
    80  
    81  ## License agreement
    82  
    83  The use of this software package is governed by the end-user license agreement 
    84  (EULA) available at: https://unidoc.io/eula/