Merge pull request #175 from chinapandaman/PPF-174

PPF-174: update docs with read method

Author: chinapandaman

README.md

@@ -48,7 +48,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 After running the above code snippet you can find `output.pdf` at the location you specified, 

docs/v2/api_reference.md

@@ -126,6 +126,10 @@ Its values currently support the following:
 * **editable** - only available if `simple_mode` is `True`, enabling this will allow the filled PDF to be still 
 editable. NOTE: `image` elements that are filled via the `fill` method will NOT be editable even if this is `True`.
 
+### **read**()
+
+Returns the `stream`. This method allows the implementation of PyPDFForm to behave like a file object.
+
 ### **register_font**(*font_name, ttf_stream*)
 
 This class method takes a TTF font file stream and register it with the `font_name` specified. 

docs/v2/examples.md

@@ -45,7 +45,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/simple_fill.py
@@ -81,7 +81,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/simple_fill_editable.py
@@ -126,7 +126,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_font.py
@@ -167,7 +167,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_global_font_size_color.py
@@ -205,7 +205,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_text_wrap.py
@@ -246,7 +246,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_text_offset.py
@@ -274,7 +274,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     filled_pdf = PyPDFForm(template.read()).draw_text("drawn_text", 1, 300, 225)
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/draw_text.py
@@ -307,7 +307,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
         )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/draw_image.py
@@ -345,7 +345,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
         )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Alternatively you can use the assignment operator to achieve the same.
@@ -379,7 +379,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
         )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/merge.py
@@ -435,7 +435,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(pdf_form.stream)
+        output.write(pdf_form.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_customized_elements.py
@@ -469,7 +469,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/simple_fill_radio.py
@@ -528,7 +528,7 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())
 ```
 
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_images.py

examples/draw_image.py

@@ -21,4 +21,4 @@
         )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/draw_text.py

@@ -14,4 +14,4 @@
     filled_pdf = PyPDFForm(template.read()).draw_text("drawn_text", 1, 300, 225)
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/fill_customized_elements.py

@@ -42,4 +42,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(pdf_form.stream)
+        output.write(pdf_form.read())

examples/fill_font.py

@@ -34,4 +34,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/fill_global_font_size_color.py

@@ -28,4 +28,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/fill_images.py

@@ -41,4 +41,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/fill_text_offset.py

@@ -28,4 +28,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/fill_text_wrap.py

@@ -27,4 +27,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/merge.py

@@ -26,4 +26,4 @@
         )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/simple_fill.py

@@ -23,4 +23,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/simple_fill_editable.py

@@ -24,4 +24,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())

examples/simple_fill_radio.py

@@ -20,4 +20,4 @@
     )
 
     with open(PATH_TO_FILLED_PDF_FORM, "wb+") as output:
-        output.write(filled_pdf.stream)
+        output.write(filled_pdf.read())