unicorn/bindings/python
Nguyen Anh Quynh 7cad644235
bindings: update for latest ARM registers addition
Backports commit 07cafff76a3093376755e61124124f6f593d64c9 from unicorn
2019-03-08 02:27:24 -05:00
..
prebuilt
unicorn bindings: update for latest ARM registers addition 2019-03-08 02:27:24 -05:00
Makefile
MANIFEST.in
README.TXT Cleanups/fixes for the library issue conglomerate (#897) 2017-09-24 22:33:01 +08:00
sample_all.sh
sample_arm.py
sample_arm64.py
sample_arm64eb.py
sample_armeb.py
sample_m68k.py
sample_mips.py
sample_network_auditing.py
sample_sparc.py
sample_x86.py Fix naming in Python sample_x86.py (#961) 2019-02-28 17:01:10 -05:00
setup.cfg
setup.py Cleanups/fixes for the library issue conglomerate (#897) 2017-09-24 22:33:01 +08:00
shellcode.py update python binding samples, shellcode.py with 64bit syscall (#1052) 2019-02-28 16:47:23 -05:00

This documentation explains how to install the python binding for Unicorn
from source.

1. Installing on Linux:

	$ sudo python setup.py install

	This will build the core C library, package it with the python bindings, 
	and install it to your system.

    If you want to prevent the build of the native library during the python installation,
    set the environment variable LIBUNICORN_PATH. You may also set this to a directory
    containing libunicorn.so if you wish to use a verison of the native library other than
    the globally installed one.


2. Installing on Windows:

	Run the following command in command prompt:

		C:\> C:\location_to_python\python.exe setup.py install

	Next, copy all the DLL files from the 'Core engine for Windows' package available
	on the Unicorn download page and paste it in the path:

		C:\location_to_python\Lib\site-packages\unicorn\


3. Sample code

	This directory contains some sample code to show how to use Unicorn API.

	- sample_<arch>.py
	  These code show how to access architecture-specific information for each
	  architecture.

	- shellcode.py
	  This shows how to analyze a Linux shellcode.

	- sample_network_auditing.py
	  This shows how to analyze & interpret Linux shellcode.