Merge pull request #157 from chinapandaman/PPF-156

PPF-156: move sample images out of sample pdfs folder

Author: chinapandaman

PyPDFForm/__init__.py

@@ -1,3 +1,5 @@
 # -*- coding: utf-8 -*-
 
 from .middleware.wrapper import PyPDFForm
+
+__version__ = "0.2.2"

PyPDFForm/middleware/exceptions/input.py

@@ -9,7 +9,7 @@ class InvalidModeError(BasePyPDFFormException):
 
 
 class InvalidFormDataError(BasePyPDFFormException):
-    """Raised when form data input is not a dictionary."""
+    """Raised when form data input is not a dictionary with appropriate key value types."""
 
 
 class InvalidEditableParameterError(BasePyPDFFormException):

docs/v2/examples.md

@@ -441,9 +441,13 @@ with open(PATH_TO_DOWNLOADED_SAMPLE_PDF_FORM, "rb+") as template:
 Link to this example: https://github.com/chinapandaman/PyPDFForm/blob/master/examples/fill_customized_elements.py
 
 
-## Filling a PDF form with image elements
+## Fill a PDF form with image elements
 
-This example uses this [template](https://github.com/chinapandaman/PyPDFForm/blob/master/pdf_samples/v2/sample_template_with_image_field.pdf). 
+This example uses this [template](https://github.com/chinapandaman/PyPDFForm/blob/master/pdf_samples/v2/sample_template_with_image_field.pdf) 
+and these images: 
+[image 1](https://github.com/chinapandaman/PyPDFForm/blob/master/image_samples/sample_image.jpg), 
+[image 2](https://github.com/chinapandaman/PyPDFForm/blob/master/image_samples/sample_image_2.jpg),
+[image 3](https://github.com/chinapandaman/PyPDFForm/blob/master/image_samples/sample_image_3.jpg). 
 It demos filling a PDF form's image elements.
 
 ```python

pdf_samples/v2/sample_image.jpg image_samples/sample_image.jpg

@@ -1,7 +1,12 @@
 # -*- coding: utf-8 -*-
 
+import re
+
 import setuptools
 
+with open("PyPDFForm/__init__.py", encoding="utf8") as f:
+    version = re.search(r'__version__ = "(.*?)"', f.read()).group(1)
+
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
@@ -16,7 +21,7 @@
 
 setuptools.setup(
     name="PyPDFForm",
-    version="0.2.1",
+    version=version,
     description="python library for PDF forms",
     long_description=long_description,
     long_description_content_type="text/markdown",

pdf_samples/v2/sample_image_2.jpg image_samples/sample_image_2.jpg

@@ -13,6 +13,11 @@ def pdf_samples():
     return os.path.join(os.path.dirname(__file__), "..", "..", "pdf_samples", "v2")
 
 
+@pytest.fixture
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
 @pytest.fixture
 def font_samples():
     return os.path.join(os.path.dirname(__file__), "..", "..", "font_samples")
@@ -25,8 +30,8 @@ def template_stream(pdf_samples):
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()
 
 

pdf_samples/v2/sample_image_3.jpg image_samples/sample_image_3.jpg

@@ -14,6 +14,11 @@ def pdf_samples():
     return os.path.join(os.path.dirname(__file__), "..", "..", "pdf_samples", "v2")
 
 
+@pytest.fixture
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
 @pytest.fixture
 def template_stream(pdf_samples):
     with open(os.path.join(pdf_samples, "sample_template.pdf"), "rb+") as f:
@@ -46,20 +51,20 @@ def template_with_image_stream(pdf_samples):
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()
 
 
 @pytest.fixture
-def image_stream_2(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image_2.jpg"), "rb+") as f:
+def image_stream_2(image_samples):
+    with open(os.path.join(image_samples, "sample_image_2.jpg"), "rb+") as f:
         return f.read()
 
 
 @pytest.fixture
-def image_stream_3(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image_3.jpg"), "rb+") as f:
+def image_stream_3(image_samples):
+    with open(os.path.join(image_samples, "sample_image_3.jpg"), "rb+") as f:
         return f.read()
 
 

setup.py

@@ -24,15 +24,20 @@ def pdf_samples():
     return os.path.join(os.path.dirname(__file__), "..", "..", "pdf_samples", "v2")
 
 
+@pytest.fixture
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
 @pytest.fixture
 def template_stream(pdf_samples):
     with open(os.path.join(pdf_samples, "sample_template.pdf"), "rb+") as f:
         return f.read()
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()
 
 

tests/functional/test_draw_on_pdf.py

@@ -22,8 +22,13 @@ def pdf_samples():
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
+@pytest.fixture
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()
 
 

tests/functional/test_fill.py

@@ -18,6 +18,11 @@ def pdf_samples():
     return os.path.join(os.path.dirname(__file__), "..", "..", "pdf_samples", "v2")
 
 
+@pytest.fixture
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
 @pytest.fixture
 def template_stream(pdf_samples):
     with open(os.path.join(pdf_samples, "sample_template.pdf"), "rb+") as f:
@@ -33,20 +38,20 @@ def template_with_image_stream(pdf_samples):
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()
 
 
 @pytest.fixture
-def image_stream_2(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image_2.jpg"), "rb+") as f:
+def image_stream_2(image_samples):
+    with open(os.path.join(image_samples, "sample_image_2.jpg"), "rb+") as f:
         return f.read()
 
 
 @pytest.fixture
-def image_stream_3(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image_3.jpg"), "rb+") as f:
+def image_stream_3(image_samples):
+    with open(os.path.join(image_samples, "sample_image_3.jpg"), "rb+") as f:
         return f.read()
 
 

tests/functional/test_input_validations.py

@@ -15,8 +15,13 @@ def pdf_samples():
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
+@pytest.fixture
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()
 
 

tests/unit/test_element.py

@@ -17,15 +17,20 @@ def pdf_samples():
     return os.path.join(os.path.dirname(__file__), "..", "..", "pdf_samples", "v2")
 
 
+@pytest.fixture
+def image_samples():
+    return os.path.join(os.path.dirname(__file__), "..", "..", "image_samples")
+
+
 @pytest.fixture
 def template_stream(pdf_samples):
     with open(os.path.join(pdf_samples, "sample_template.pdf"), "rb+") as f:
         return f.read()
 
 
 @pytest.fixture
-def image_stream(pdf_samples):
-    with open(os.path.join(pdf_samples, "sample_image.jpg"), "rb+") as f:
+def image_stream(image_samples):
+    with open(os.path.join(image_samples, "sample_image.jpg"), "rb+") as f:
         return f.read()