README.rst

   1 ==========
   2 pyelftools
   3 ==========
   4
   5 .. image:: https://github.com/eliben/pyelftools/workflows/pyelftools-tests/badge.svg
   6   :align: center
   7   :target: https://github.com/eliben/pyelftools/actions
   8
   9 **pyelftools** is a pure-Python library for parsing and analyzing ELF files
  10 and DWARF debugging information. See the
  11 `User's guide <https://github.com/eliben/pyelftools/wiki/User's-guide>`_
  12 for more details.
  13
  14 Pre-requisites
  15 --------------
  16
  17 As a user of **pyelftools**, one only needs Python 3 to run. For hacking on
  18 **pyelftools** the requirements are a bit more strict, please see the `hacking
  19 guide <https://github.com/eliben/pyelftools/wiki/Hacking-guide>`_.
  20
  21 Installing
  22 ----------
  23
  24 **pyelftools** can be installed from PyPI (Python package index)::
  25
  26     > pip install pyelftools
  27
  28 Alternatively, you can download the source distribution for the most recent and
  29 historic versions from the *Downloads* tab on the `pyelftools project page
  30 <https://github.com/eliben/pyelftools>`_ (by going to *Tags*). Then, you can
  31 install from source, as usual::
  32
  33     > python setup.py install
  34
  35 Since **pyelftools** is a work in progress, it's recommended to have the most
  36 recent version of the code. This can be done by downloading the `master zip
  37 file <https://github.com/eliben/pyelftools/archive/master.zip>`_ or just
  38 cloning the Git repository.
  39
  40 Since **pyelftools** has no external dependencies, it's also easy to use it
  41 without installing, by locally adjusting ``PYTHONPATH``.
  42
  43 How to use it?
  44 --------------
  45
  46 **pyelftools** is a regular Python library: you import and invoke it from your
  47 own code. For a detailed usage guide and links to examples, please consult the
  48 `user's guide <https://github.com/eliben/pyelftools/wiki/User's-guide>`_.
  49
  50 License
  51 -------
  52
  53 **pyelftools** is open source software. Its code is in the public domain. See
  54 the ``LICENSE`` file for more details.