README.rst

   1 Introduction: what is pyelftools?
   2 ---------------------------------
   3
   4 **pyelftools** is a pure-Python library for parsing and analyzing ELF files
   5 and DWARF debugging information. See the
   6 `User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_ for more details.
   7
   8 Pre-requisites
   9 --------------
  10
  11 As a user of **pyelftools**, one only needs Python to run. It works with
  12 Python versions 2.6, 2.7 and 3.2. For hacking on **pyelftools** the
  13 requirements are a bit more strict, please see the
  14 `hacking guide <https://bitbucket.org/eliben/pyelftools/wiki/Hacking>`_.
  15
  16 Installing
  17 ----------
  18
  19 **pyelftools** can be installed from PyPI (Python package index)::
  20
  21     > pip install pyelftools
  22
  23 Alternatively, you can download the source distribution for the most recent and
  24 historic versions from the *Downloads* tab on the `pyelftools project page
  25 <https://bitbucket.org/eliben/pyelftools>`_ (by going to *Tags*). Then, you can
  26 install from source, as usual::
  27
  28     > python setup.py install
  29
  30 How to use it?
  31 --------------
  32
  33 **pyelftools** is a regular Python library: you import and invoke it from your
  34 own code. For a detailed usage guide and links to examples, please consult the
  35 `user's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_.
  36
  37 License
  38 -------
  39
  40 **pyelftools** is open source software. Its code is in the public domain. See
  41 the ``LICENSE`` file for more details.
  42
  43
  44
  45