Merge pull request #436 from chinapandaman/PPF-435

PPF-435: release 1.4.0

PyPDFForm/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """Contains any object users might need."""
 
-__version__ = "1.3.5"
+__version__ = "1.4.0"
 
 from .wrapper import PdfWrapper, PyPDFForm

README.md

@@ -8,6 +8,22 @@
     <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-orange.svg"></a>
 </p>
 
+## Important API Changes
+
+Happy new year fellow developers! We start the year 2024 with a new release of v1.4.0 and 
+there are some important changes I'm making to the APIs of the library.
+
+* The PDF object that gets instantiated is now `PyPDFForm.PdfWrapper`, changed from `PyPDFForm.PyPDFForm`.
+* Form widgets are now accessed via the `PdfWrapper.widgets` attribute, changed from `PdfWrapper.elements`.
+* The JSON schema of the form data is now accessed via a new attribute called `PdfWrapper.schema`, 
+changed from the old method of `PdfWrapper.generate_schema()`.
+
+All the old APIs will be persisted for half a year and then fully deprecated. Each of them 
+will emit a `DeprecationWarning` when invoked, so it is advised that you make the switch before they are 
+removed and start breaking your code.
+
+Happy hacking!
+
 ## Introduction
 
 PyPDFForm is a pure Python library for PDF form processing.