Updated Post Consume Script Examples (markdown)

Post-Consume-Script-Examples.md

@@ -1 +1,73 @@
 This wiki page is a repository of example [post-consume scripts](https://docs.paperless-ngx.com/advanced_usage/#post-consume-script) contributed by the community. As always, you should exercise caution when using a script and make sure you understand the code before using a script from the internet.
+
+## Python + API
+```python
+#!/usr/bin/env python3
+
+import requests
+import json
+import sys
+from datetime import datetime
+import os
+from typing import Tuple
+
+
+def _set_auth_tokens(paperless_url: str, session: requests.Session) -> Tuple[str, str]:
+    # TODO: You fill these in or otherwise provide them
+    credentials = {"username": "test", "password": "test"}
+
+    response = sess.get(paperless_url)
+    response.raise_for_status()
+
+    csrf_token = response.cookies["csrftoken"]
+
+    response = sess.post(
+        paperless_url + "/api/token/",
+        data=credentials,
+        headers={"X-CSRFToken": csrf_token},
+    )
+    response.raise_for_status()
+
+    api_token = response.json()["token"]
+
+    sess.headers.update(
+        {"Authorization": f"Token {api_token}", f"X-CSRFToken": csrf_token}
+    )
+
+
+if __name__ == "__main__":
+    # Running inside the Docker container
+    paperless_url = "http://192.168.1.12:8180"
+
+    with requests.Session() as sess:
+        # Set tokens for the appropriate header auth
+        _set_auth_tokens(paperless_url, sess)
+
+        # Get the PK as provided via post-consume
+        doc_pk = int(os.environ["DOCUMENT_ID"])
+
+        # Query the API for the document info
+        doc_info_resp = sess.get(paperless_url + f"/api/documents/{doc_pk}/")
+        doc_info_resp.raise_for_status()
+        doc_info = doc_info_resp.json()
+
+        # Extract the currently assigned values
+        correspondent = doc_info["correspondent"]
+        doc_type = doc_info["document_type"]
+        doc_original_name = doc_info["original_file_name"]
+        # etc...
+
+        # Parse, set, otherwise choose new values
+        # TODO: Up to the user to decide how these new values should be set
+        # Use regex, etc to get the primary key of the new values
+        new_correspondent = 123
+        new_doc_type = 456
+
+        # Update the document
+        resp = sess.patch(
+            paperless_url + f"/api/documents/{doc_pk}/",
+            data={"correspondent": new_correspondent, "document_type": new_doc_type},
+        )
+        resp.raise_for_status()
+
+```