anvilco · aalmazan · Jan 10, 2023 · Jan 9, 2023 · Jan 9, 2023 · Jan 9, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# 1.8.0 (2022-09-09)
+
+- Added support for multipart uploads on `CreateEtchPacket` requests.
+- New example for multipart uploads in `examples/create_etch_upload_file_multipart.py`
+- Added environment variable usage in all `examples/` files for easier usage.
+- Updated a few minor development packages.
+
 # 1.7.0 (2022-09-09)
 
 - Added support for `version_number` in PDF Fill requests.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
 mkdocs==1.3.0; python_version >= "3.6"
-pygments==2.12.0; python_version >= "3.6"
+pygments==2.14.0; python_version >= "3.6"
diff --git a/examples/create_etch_existing_cast.py b/examples/create_etch_existing_cast.py
@@ -1,11 +1,15 @@
 # pylint: disable=duplicate-code
 
+import os
+
 from python_anvil.api import Anvil
 from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket
 from python_anvil.api_resources.payload import EtchCastRef, EtchSigner, SignerField
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():

diff --git a/examples/create_etch_markdown.py b/examples/create_etch_markdown.py
@@ -1,5 +1,7 @@
 # pylint: disable=duplicate-code
 
+import os
+
 from python_anvil.api import Anvil
 from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket
 from python_anvil.api_resources.payload import (
@@ -11,7 +13,9 @@
 )
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():

diff --git a/examples/create_etch_markup.py b/examples/create_etch_markup.py
@@ -1,5 +1,7 @@
 # pylint: disable=duplicate-code
 
+import os
+
 from python_anvil.api import Anvil
 from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket
 from python_anvil.api_resources.payload import (
@@ -10,7 +12,9 @@
 )
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():

diff --git a/examples/create_etch_upload_file.py b/examples/create_etch_upload_file.py
@@ -1,6 +1,7 @@
 # pylint: disable=duplicate-code
 
 import base64
+import os
 
 from python_anvil.api import Anvil
 from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket
@@ -13,7 +14,9 @@
 )
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():

diff --git a/examples/create_etch_upload_file_multipart.py b/examples/create_etch_upload_file_multipart.py
@@ -0,0 +1,148 @@
+# pylint: disable=duplicate-code
+import os
+
+from python_anvil.api import Anvil
+from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket
+from python_anvil.api_resources.payload import (
+    DocumentUpload,
+    EtchSigner,
+    SignatureField,
+    SignerField,
+)
+
+
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
+
+
+def main():
+    anvil = Anvil(api_key=API_KEY)
+
+    # Create an instance of the builder
+    packet = CreateEtchPacket(
+        name="Etch packet with existing template multipart",
+        #
+        # Optional changes to email subject and body content
+        signature_email_subject="Please sign these forms",
+        signature_email_body="This form requires information from your driver's "
+        "license. Please have that available.",
+        #
+        # URL where Anvil will send POST requests when server events happen.
+        # Take a look at https://www.useanvil.com/docs/api/e-signatures#webhook-notifications
+        # for other details on how to configure webhooks on your account.
+        # You can also use sites like webhook.site, requestbin.com or ngrok to
+        # test webhooks.
+        # webhook_url="https://my.webhook.example.com/etch-events/",
+        #
+        # Email overrides for the "reply-to" email header for signer emails.
+        # If used, both `reply_to_email` and `reply_to_name` are required.
+        # By default, this will point to your organization support email.
+        # reply_to_email="[email protected]",
+        # reply_to_name="My Name",
+        #
+        # Merge all PDFs into one. Use this if you have many PDF templates
+        # and/or files, but want the final downloaded package to be only
+        # 1 PDF file.
+        # merge_pdfs=True,
+    )
+
+    # Get your file(s) ready to sign.
+    # For this example, the PDF hasn't been uploaded to Anvil yet.
+    # In the `create_etch_upload_file.py` example, we are base64 encoding our
+    # file(s) before sending. In this case, we will be providing a file's path
+    # or file descriptor (from an `open()` call)
+    filename = "my_local_file.pdf"
+    file_dir = os.path.dirname(os.path.realpath(__file__))
+    file_path = os.path.join(file_dir, filename)
+
+    # You can check manually if your file exists, however, the validator being
+    # used in the `GraphqlUpload` below will also check if the file exists.
+    #
+    # if not os.path.exists(file_path):
+    #     raise FileNotFoundError('File does not exist. Please check `file_path` '
+    #                             'and ensure it points to an existing file.')
+
+    # Upload the file and define signer field locations.
+    file1 = DocumentUpload(
+        id="myNewFile",
+        title="Please sign this important form",
+        # You can send a callable that returns a file handle and the filename
+        # you want to use in the Anvil app.
+        # (IMPORTANT: The data must be read in as _bytes_, not text.)
+        file=lambda: (
+            open(file_path, "rb"),  # pylint: disable=consider-using-with
+            filename,
+        ),
+        # or just the valid path itself
+        # file=file_path,
+        fields=[
+            SignatureField(
+                id="sign1",
+                type="signature",
+                page_num=0,
+                # The position and size of the field. The coordinates provided here
+                # (x=100, y=100) is the top-left of the rectangle.
+                rect=dict(x=183, y=100, width=250, height=50),
+            )
+        ],
+    )
+
+    # Gather your signer data
+    signer1 = EtchSigner(
+        name="Jackie",
+        email="[email protected]",
+        # Fields where the signer needs to sign.
+        # Check your cast fields via the CLI (`anvil cast [cast_eid]`) or the
+        # PDF Templates section on the Anvil app.
+        # This basically says: "In the 'myNewFile' file (defined in
+        # `file1` above), assign the signature field with cast id of
+        # 'sign1' to this signer." You can add multiple signer fields here.
+        fields=[
+            SignerField(
+                # this is the `id` in the `DocumentUpload` object above
+                file_id="myNewFile",
+                # This is the signing field id in the `SignatureField` above
+                field_id="sign1",
+            )
+        ],
+        signer_type="embedded",
+        #
+        # You can also change how signatures will be collected.
+        # "draw" will allow the signer to draw their signature
+        # "text" will insert a text version of the signer's name into the
+        # signature field.
+        # signature_mode="draw",
+        #
+        # Whether to the signer is required to click each signature
+        # field manually. If `False`, the PDF will be signed once the signer
+        # accepts the PDF without making the user go through the PDF.
+        # accept_each_field=False,
+        #
+        # URL of where the signer will be redirected after signing.
+        # The URL will also have certain URL params added on, so the page
+        # can be customized based on the signing action.
+        # redirect_url="https://www.google.com",
+    )
+
+    # Add your signer.
+    packet.add_signer(signer1)
+
+    # Add files to your payload
+    packet.add_file(file1)
+
+    # If needed, you can also override or add additional payload fields this way.
+    # This is useful if the Anvil API has new features, but `python-anvil` has not
+    # yet been updated to support it.
+    # payload = packet.create_payload()
+    # payload.aNewFeature = True
+
+    # Create your packet
+    # If overriding/adding new fields, use the modified payload from
+    # `packet.create_payload()`
+    res = anvil.create_etch_packet(payload=packet, include_headers=True)
+    print(res)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/examples/create_workflow_submission.py b/examples/create_workflow_submission.py
@@ -1,10 +1,13 @@
+import os
 from datetime import datetime
 
 from python_anvil.api import Anvil
 from python_anvil.api_resources.payload import ForgeSubmitPayload
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():

diff --git a/examples/fill_pdf.py b/examples/fill_pdf.py
@@ -1,7 +1,11 @@
+import os
+
 from python_anvil.api import Anvil
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():

diff --git a/examples/generate_pdf.py b/examples/generate_pdf.py
@@ -1,8 +1,12 @@
+import os
+
 from python_anvil.api import Anvil
 from python_anvil.api_resources.payload import GeneratePDFPayload
 
 
-API_KEY = 'my-api-key'
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
 
 
 def main():