From 1caefedc6adf06c049ca925c1d1217bc13e9e51f Mon Sep 17 00:00:00 2001 From: Wesley Shields Date: Sat, 30 Nov 2013 23:08:44 -0500 Subject: [PATCH] Start to document things. --- python/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/python/README.md b/python/README.md index 9ce54ad..5a2c8e7 100644 --- a/python/README.md +++ b/python/README.md @@ -12,6 +12,25 @@ libraries) you can build pepy. 2. Install pepy: * python setup.py install +Using +===== +There are a number of objects involved in pepy. The main one is the *parsed* +object. This object is returned by the *parse* method. + +` +import pepy +p = pepy.parse("/path/to/exe") +` + +The *parsed* object has a number of methods: + +* get_entry_point: Return the entry point address +* get_bytes: Return the first N bytes at a given address +* get_sections: Return a list of section objects +* get_imports: Return a list of import objects. +* get_exports: Return a list of export objects. +* get_relocations: Return a list of relocation objects + Authors ======= pe-parse was designed and implemented by Andrew Ruef (andrew@trailofbits.com)