✅ add default code sample (#129)

Author: ianardee

docs/extras/code_samples/default.txt

@@ -0,0 +1,21 @@
+import json
+import requests
+
+api_key = "my-api-key"
+account = "my-account"
+endpoint = "my-endpoint"
+version = "my-version"
+
+url = f"https://api.mindee.net/v1/products/{account}/{endpoint}/v{version}/predict"
+
+with open("/path/to/the/file.ext", "rb") as file_handle:
+    files = {"document": file_handle}
+    headers = {"Authorization": f"Token {api_key}"}
+    response = requests.post(url, files=files, headers=headers)
+
+json_response = response.json()
+
+if not response.ok:
+    raise RuntimeError(json_response["api_request"]["error"])
+
+print(json.dumps(json_response["document"], indent=2))

tests/test_code_samples.sh

@@ -14,13 +14,21 @@ do
   echo "###############################################"
   echo
 
-  sed "s/my-api-key/${API_KEY}/" "$f" > $OUTPUT_FILE
+  sed "s/my-api-key/${API_KEY}/" "${f}" > $OUTPUT_FILE
   sed -i 's/\/path\/to\/the\/file.ext/.\/tests\/data\/pdf\/blank_1.pdf/' $OUTPUT_FILE
 
   if echo "$f" | grep -q "custom_v1.txt"
   then
     sed -i "s/my-account/$ACCOUNT/g" $OUTPUT_FILE
     sed -i "s/my-endpoint/$ENDPOINT/g" $OUTPUT_FILE
   fi
+
+  if echo "${f}" | grep -q "default.txt"
+  then
+    sed -i "s/my-account/$ACCOUNT/" $OUTPUT_FILE
+    sed -i "s/my-endpoint/$ENDPOINT/" $OUTPUT_FILE
+    sed -i "s/my-version/1/" $OUTPUT_FILE
+  fi
+
   python $OUTPUT_FILE
 done