Start to document things.

This commit is contained in:
Wesley Shields 2013-11-30 23:08:44 -05:00
parent b867946050
commit 1caefedc6a

View File

@ -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)