summaryrefslogtreecommitdiff
path: root/docs/dev/batch.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-06-19 17:41:24 +0100
committerJordan Wiens <jordan@psifertex.com>2023-06-19 17:41:24 +0100
commit6239817e602220442891d9c81617603165d79808 (patch)
tree80e6535a73e0f1acb6d2fed269fae0801f4659b4 /docs/dev/batch.md
parentff7d32f2ec4dec9928dc579d3d1442ab409aad8e (diff)
update documentation about headless python installs
Diffstat (limited to 'docs/dev/batch.md')
-rw-r--r--docs/dev/batch.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/dev/batch.md b/docs/dev/batch.md
index 3b0896a2..8dbd908d 100644
--- a/docs/dev/batch.md
+++ b/docs/dev/batch.md
@@ -4,6 +4,13 @@ An often asked question of Binary Ninja is "How do I enable batch-processing mod
This document describes some general tips and tricks for effective batch processing. In particular, because Binary Ninja is multi-threaded, some methods for faster processing like [multiprocessing](https://docs.python.org/3/library/multiprocessing.html) can have dangerous consequences.
+## Dedicated Python
+
+While MacOS, Linux, and Windows all ship with python interpreters, those are only tested and intended for use within the scripting console. For headless automation, first install a dedicated python and using the steps in the next section to add the Binary Ninja libraries to the paths of that environment.
+
+???+ Danger "Warning"
+ Do NOT use the Python available in the Windows App Store as its sandbox protections prevent it from working with other libraries.
+
## Install the API
First, make sure to run the [install_api.py](https://github.com/Vector35/binaryninja-api/tree/dev/scripts) script. Note that the script is shipped with Binary Ninja already, just look in your [binary path](../guide/index.md#binary-path) inside of the `scripts` subfolder. Run it like: