blob: a66aa289a79eea442b910ef3312dc133ceed408c [file] [log] [blame]
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 <>`_ for more details.
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 <>`_.
When you unzip the source distribution, run::
> python install
Alternatively, **pyelftools** can be installed from PyPI (Python package
> 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 <>`_.
**pyelftools** is open source software. Its code is in the public domain. See
the ``LICENSE`` file for more details.