Merge pull request #260 from chinapandaman/PPF-259

PPF-259: add how to contribute

Author: chinapandaman

PyPDFForm/__init__.py

@@ -7,4 +7,4 @@
 PyPDFForm = Wrapper
 PyPDFForm2 = WrapperV2
 
-__version__ = "1.0.2"
+__version__ = "1.0.3"

README.md

@@ -68,3 +68,13 @@ functionalities.
 
 It is strongly advised that you use PyPDFForm2 since only minimum supports will be made to PyPDFForm 
 from now on.
+
+## How to Contribute
+
+If you wish to improve this library, there is one specific way you can contribute 
+on top of the usual open source project norms such as issues and pull requests.
+
+It is difficult to make sure that the library supports all the PDF form creating tools out 
+there. So if you run into a case where the library does not work for certain PDF forms created by 
+certain tools, feel free to open an issue with the problematic PDF form attached. I will seek 
+to make the library support the attached PDF form as well as the tool used to create it.

image_samples/after_converted_linux.jpg

@@ -107,13 +107,6 @@ def test_draw_image_on_one_page(template_stream, image_stream, pdf_samples):
     if os.name == "nt":
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
-    else:
-        with open(
-            os.path.join(pdf_samples, "sample_pdf_with_image_linux.pdf"), "rb+"
-        ) as f_linux:
-            expected = f_linux.read()
-            assert len(obj.stream) == len(expected)
-            assert obj.stream == expected
 
 
 def test_draw_image_on_one_page_fp_param(template_stream, image_samples, pdf_samples):
@@ -127,13 +120,6 @@ def test_draw_image_on_one_page_fp_param(template_stream, image_samples, pdf_sam
     if os.name == "nt":
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
-    else:
-        with open(
-            os.path.join(pdf_samples, "sample_pdf_with_image_linux.pdf"), "rb+"
-        ) as f_linux:
-            expected = f_linux.read()
-            assert len(obj.stream) == len(expected)
-            assert obj.stream == expected
 
 
 def test_draw_image_on_one_page_f_obj_param(
@@ -148,13 +134,6 @@ def test_draw_image_on_one_page_f_obj_param(
     if os.name == "nt":
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
-    else:
-        with open(
-            os.path.join(pdf_samples, "sample_pdf_with_image_linux.pdf"), "rb+"
-        ) as f_linux:
-            expected = f_linux.read()
-            assert len(obj.stream) == len(expected)
-            assert obj.stream == expected
 
 
 def test_draw_png_image_on_one_page(template_stream, image_samples, pdf_samples):
@@ -173,10 +152,3 @@ def test_draw_png_image_on_one_page(template_stream, image_samples, pdf_samples)
         if os.name == "nt":
             assert len(obj.stream) == len(expected)
             assert obj.stream == expected
-        else:
-            with open(
-                os.path.join(pdf_samples, "sample_pdf_with_png_image_linux.pdf"), "rb+"
-            ) as f_linux:
-                expected = f_linux.read()
-                assert len(obj.stream) == len(expected)
-                assert obj.stream == expected

pdf_samples/sample_pdf_with_image_linux.pdf

@@ -389,13 +389,6 @@ def test_draw_image_on_one_page_v2(template_stream, image_samples, pdf_samples):
         if os.name == "nt":
             assert len(obj.stream) == len(expected)
             assert obj.stream == expected
-        else:
-            with open(
-                os.path.join(pdf_samples, "sample_pdf_with_image_linux.pdf"), "rb+"
-            ) as f_linux:
-                expected = f_linux.read()
-                assert len(obj.stream) == len(expected)
-                assert obj.stream == expected
 
 
 def test_draw_png_image_on_one_page_v2(template_stream, image_samples, pdf_samples):
@@ -414,13 +407,6 @@ def test_draw_png_image_on_one_page_v2(template_stream, image_samples, pdf_sampl
         if os.name == "nt":
             assert len(obj.stream) == len(expected)
             assert obj.stream == expected
-        else:
-            with open(
-                os.path.join(pdf_samples, "sample_pdf_with_png_image_linux.pdf"), "rb+"
-            ) as f_linux:
-                expected = f_linux.read()
-                assert len(obj.stream) == len(expected)
-                assert obj.stream == expected
 
 
 def test_addition_operator_3_times_v2(template_stream, pdf_samples, data_dict):

pdf_samples/sample_pdf_with_png_image_linux.pdf

@@ -37,12 +37,6 @@ def after_converted(image_samples):
         return f.read()
 
 
-@pytest.fixture
-def after_converted_linux(image_samples):
-    with open(os.path.join(image_samples, "after_converted_linux.jpg"), "rb+") as f:
-        return f.read()
-
-
 def test_is_image(image_stream):
     assert not ImageCore().is_image(b"bad_stream")
     assert ImageCore().is_image(image_stream)
@@ -67,9 +61,8 @@ def test_rotate_image(image_stream):
     rotated_buff.close()
 
 
-def test_any_image_to_jpg(before_converted, after_converted, after_converted_linux):
+def test_any_image_to_jpg(before_converted, after_converted):
     _converted = ImageCore().any_image_to_jpg(before_converted)
-    assert len(_converted) == (
-        len(after_converted) if os.name == "nt" else len(after_converted_linux)
-    )
-    assert _converted == (after_converted if os.name == "nt" else after_converted_linux)
+    if os.name == "nt":
+        assert len(_converted) == len(after_converted)
+        assert _converted == after_converted