https://github.com/eliben/pyelftools

Parsing ELF and DWARF in Python
https://github.com/eliben/pyelftools

debugging dwarf elf elf-binaries elf-parser python

Last synced: 4 days ago
JSON representation

Parsing ELF and DWARF in Python

• Host: GitHub
• URL: https://github.com/eliben/pyelftools
• Owner: eliben
• License: other
• Created: 2013-06-08T22:55:54.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T12:34:49.000Z (about 2 months ago)
• Last Synced: 2024-10-29T11:18:29.206Z (about 1 month ago)
• Topics: debugging, dwarf, elf, elf-binaries, elf-parser, python
• Language: Python
• Homepage:
• Size: 23.5 MB
• Stars: 2,020
• Watchers: 69
• Forks: 510
• Open Issues: 72
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• stars - eliben/pyelftools
• best-of-python-dev - GitHub - 28% open · ⏱️ 15.05.2024): (Debugging Tools)
• awesome-python-resources - GitHub - 30% open · ⏱️ 22.08.2022): (调试工具)

README

        
==========

pyelftools

==========

.. image:: https://github.com/eliben/pyelftools/workflows/pyelftools-tests/badge.svg

  :align: center

  :target: https://github.com/eliben/pyelftools/actions

**pyelftools** is a pure-Python library for parsing and analyzing ELF files

and DWARF debugging information. See the

`User's guide `_

for more details.

Pre-requisites

--------------

As a user of **pyelftools**, one only needs Python 3 to run. While there is no

reason for the library to not work on earlier versions of Python, our CI

tests are based on the official

`Status of Python versions `__.

Installing

----------

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

    > pip install pyelftools

Alternatively, you can download the source distribution for the most recent and

historic versions from the *Downloads* tab on the `pyelftools project page

`_ (by going to *Tags*). Then, you can

install from source, as usual::

    > python setup.py install

Since **pyelftools** is a work in progress, it's recommended to have the most

recent version of the code. This can be done by downloading the `master zip

file `_ or just

cloning the Git repository.

Since **pyelftools** has no external dependencies, it's also easy to use it

without installing, by locally adjusting ``PYTHONPATH``.

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 `_.

Contributing

------------

See the `Hacking Guide `__.

License

-------

**pyelftools** is open source software. Its code is in the public domain. See

the ``LICENSE`` file for more details.