blob: 836c1f289267ef88798ce5868ea01e961353f0a4 [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, 2.7 and 3.2. 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.