Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/librepdf/openpdf
OpenPDF is a free Java library for creating and editing PDF files, with a LGPL and MPL open source license. OpenPDF is based on a fork of iText. We welcome contributions from other developers. Please feel free to submit pull-requests and bugreports to this GitHub repository.
https://github.com/librepdf/openpdf
hacktoberfest itext java openpdf pdf pdf-generation
Last synced: 15 days ago
JSON representation
OpenPDF is a free Java library for creating and editing PDF files, with a LGPL and MPL open source license. OpenPDF is based on a fork of iText. We welcome contributions from other developers. Please feel free to submit pull-requests and bugreports to this GitHub repository.
- Host: GitHub
- URL: https://github.com/librepdf/openpdf
- Owner: LibrePDF
- License: other
- Created: 2016-07-11T15:50:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T08:23:23.000Z (7 months ago)
- Last Synced: 2024-04-23T23:23:09.548Z (7 months ago)
- Topics: hacktoberfest, itext, java, openpdf, pdf, pdf-generation
- Language: Java
- Homepage:
- Size: 37.3 MB
- Stars: 3,303
- Watchers: 75
- Forks: 554
- Open Issues: 106
-
Metadata Files:
- Readme: README.md
- Changelog: changelogs/1.3.27.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenPDF is an open source Java library for PDF files
OpenPDF is a Java library for creating and editing PDF files with a LGPL and MPL open source
license. OpenPDF is the LGPL/MPL open source successor of iText, and is based on some forks of iText
4 svn tag. We welcome contributions from other developers. Please feel free to submit pull-requests
and bugreports to this GitHub repository.
[](https://maven-badges.herokuapp.com/maven-central/com.github.librepdf/openpdf)
[](http://opensource.org/licenses/LGPL-2.1)
[](http://opensource.org/licenses/MPL-2.0)
[](https://app.codacy.com/gh/LibrePDF/OpenPDF/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://app.codacy.com/gh/LibrePDF/OpenPDF/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[](https://github.com/LibrePDF/OpenPDF/actions/workflows/codeql.yml)
[](https://sonarcloud.io/summary/new_code?id=LibrePDF_OpenPDF)
[](https://www.codefactor.io/repository/github/librepdf/openpdf)
[](https://gitter.im/LibrePDF/OpenPDF)
## OpenPDF version 2.0.3 released 2024-08-07
Get version 2.0.3 here: https://github.com/LibrePDF/OpenPDF/releases/tag/2.0.3
Please note: Repositories like Maven Central and others may take a few days to update.
### Other versions
- [OpenPDF 1.4.2 (release 2024-03-30)](https://github.com/LibrePDF/OpenPDF/releases/tag/1.4.2)
- [OpenPDF 1.3.43 (release 2024-03-29)](https://github.com/LibrePDF/OpenPDF/releases/tag/1.3.43)
- [Previous releases](https://github.com/LibrePDF/OpenPDF/releases)
## Features
Some of the features of OpenPDF include:
* Creating PDFs: You can use OpenPDF to create new PDF documents from scratch.
* Manipulating Existing PDFs: OpenPDF allows you to modify existing PDF documents by adding or removing pages, modifying
text, and more.
* Text and Font Support: You can add text to PDF documents using various fonts and styles, and extract text from PDF
files.
* Graphics and Images: OpenPDF supports the addition of images and graphics to PDF files.
* Table Support: The library facilitates the creation of tables in PDF documents.
* Encryption: You can encrypt PDF documents for security purposes.
* Page Layout: OpenPDF allows you to set the page size, orientation, and other layout properties.
## Use OpenPDF as Maven dependency
Add this to your pom.xml file to use the latest version of OpenPDF:
```xml
com.github.librepdf
openpdf
2.0.3
```
## License
[GNU Lesser General Public License (LGPL), Version 2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1)
> For a short explanation see https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License
[Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/2.0/)
> For a short explanation see https://en.wikipedia.org/wiki/Mozilla_Public_License
You can find also a nice explanation of these licenses under https://itsfoss.com/open-source-licenses-explained/
We want OpenPDF to consist of source code which is consistently licensed with the LGPL and MPL
licences only. This also means that any new contributions to the project must have a dual LGPL and
MPL license only.
## Documentation
- [Examples](pdf-toolbox/src/test/java/com/lowagie/examples)
- [JavaDoc](https://javadoc.io/doc/com.github.librepdf/openpdf/latest/index.html)
- [Tutorial](https://github.com/LibrePDF/OpenPDF/wiki/Tutorial) (wiki, work in progress)
- [Migration from iText, TIFF support](https://github.com/LibrePDF/OpenPDF/wiki/Migrating-from-iText-2-and-4)
## Background
OpenPDF is open source software with a LGPL and MPL license. It is a fork of iText version 4, more
specifically iText svn tag 4.2.0, which was hosted publicly on sourceforge with LGPL and MPL license
headers in the source code, and LGPL and MPL license documents in the svn repository. Beginning with
version 5.0 of iText, the developers have moved to the AGPL to improve their ability to sell
commercial licenses.
OpenPDF ancestors in GitHub (in fork order):
1. [@rtfarte](https://github.com/rtfarte) / [OpenPDF](https://github.com/rtfarte/OpenPDF) - parent
of LibrePDF/OpenPDF
2. [@kulatamicuda](https://github.com/kulatamicuda)
/ [iText-4.2.0](https://github.com/kulatamicuda/iText-4.2.0)
3. [@daviddurand](https://github.com/daviddurand)
/ [iText-4.2.0](https://github.com/daviddurand/iText-4.2.0)
4. [@ymasory](https://github.com/ymasory) / [iText-4.2.0](https://github.com/ymasory/iText-4.2.0) -
original parent on GitHub
## Projects using OpenPDF
- [Spring Framework](https://github.com/spring-projects/spring-framework)
- [flyingsaucer](https://github.com/flyingsaucerproject/flyingsaucer)
- [Digital Signature Service](https://github.com/esig/dss)
- Confluence PDF Export
- OpenCMS, Nuxeo Web Framework, QR Invoice Library and many closed source commercial applications as
well.
- Full list here: [Artifacts using OpenPDF](https://mvnrepository.com/artifact/com.github.librepdf/openpdf/usages)
## Android
OpenPDF can be used with Android, more info
here: [Android-support](https://github.com/LibrePDF/OpenPDF/wiki/Android-support)
## Contributing
Release the hounds! Please send all pull requests. Make sure that your contributions can be
released with a dual LGPL and MPL license. In particular, pull requests to the OpenPDF project must
only contain code that you have written yourself. GPL or AGPL licensed code will not be acceptable.
To contribute code to the OpenPDF project, your GitHub account must contain your real name, so that
we can verify your identity. This is to ensure the trust, security and integrity of the OpenPDF
project, and to prevent security incidents such as the "XZ Utils backdoor". Knowning the real name
of the contributors will also identify and prevent conflict of interests.
More details: [Contributing](CONTRIBUTING.md)
### Coding Style
- Code indentation style is 4 spaces. Maximum line length is 120 characters.
- Generally try to preserve the coding style in the file you are modifying.
## Dependencies
### Required Dependencies
We have now different versions of OpenPDF, and they require different versions of Java:
- The 2.0.x Branch requires Java 17 or later.
- The 1.4.x Branch requires Java 11 or later.
- The 1.3.x Branch requires Java 8 or later.
- Some versions of 1.3 where release with Java 11 as minimum requirement, but we have reverted this
to Java 8 as minimum requirement.
- OpenPDF versions 2.0.x: We are working on modernizing the OpenPDF library for Java
17+.
### UTF-8 Fonts
As of 1.3.21 the UTF-8 Liberation fonts moved to its own module, to reduce the size of the OpenPDF
jar. If you want to use the bundled UTF-8 fonts, please add the following dependency to your project
and use the class `org.librepdf.openpdf.fonts.Liberation`.
```xml
com.github.librepdf
openpdf-fonts-extra
${openpdf.version}
```
### Supporting complex glyph substitution/ Ligature substitution
OpenPDF supports glyph substitution which is required for correct rendering of fonts ligature substitution requirements.
FOP dependency is required to enable this feature. Refer following wiki for
details: [wiki](https://github.com/LibrePDF/OpenPDF/wiki/Multi-byte-character-language-support-with-TTF-fonts)
### Supporting OpenType layout, glyph positioning, reordering and substitution
OpenPDF supports OpenType layout, glyph positioning, reordering and substitution which is e.g. required for correct
positioning of accents, the rendering of non-Latin and right-to-left scripts. OpenPDF supports DIN 91379.
See: [wiki](https://github.com/LibrePDF/OpenPDF/wiki/Accents,-DIN-91379,-non-Latin-scripts)
### Optional
- [BouncyCastle](https://www.bouncycastle.org/) (BouncyCastle is used to sign PDF files, so it's a recommended
dependency)
- Provider (`org.bouncycastle:bcprov-jdk18on` or `org.bouncycastle:bcprov-ext-jdk18on` depending
on which algorithm you are using)
- PKIX/CMS (`org.bouncycastle:bcpkix-jdk18on`)
- Apache FOP (`org.apache.xmlgraphics:fop`)
- Please refer to our [pom.xml](pom.xml) to see what version is needed.
## Credits
Please see [Contributors.md](Contributors.md).