Introduction: what is pyelftools?
---------------------------------

**pyelftools** is a pure-Python library for parsing and analyzing ELF files
and DWARF debugging information. See the
`User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_ for more details.

Pre-requisites
--------------

As a user of **pyelftools**, one only needs Python to run. It works with
Python versions 2.6 and 2.7 (Python 3 support is planned). For hacking
on **pyelftools** the requirements are a bit more strict, please see the 
`hacking guide <https://bitbucket.org/eliben/pyelftools/wiki/Hacking>`_.

Installing
----------

When you unzip the source distribution, run::

    > python setup.py install

Alternatively, **pyelftools** can be installed from PyPI (Python package
index)::

    > pip install pyelftools

How to use it?
--------------

**pyelftools** is a regular Python library: you import and invoke it from your
own code. For a detailed usage guide and links to examples, please consult the
`user's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_.

License
-------

**pyelftools** is open source software. Its code is in the public domain. See
the ``LICENSE`` file for more details.