README.md

This folder contains the Python instrumentation module.

Installation

Requires that setuptools is installed (comes with pip).

You can either:

Install all Palanteer components with CMake (see ./INSTALL.md)
Indeed, this library is part of the global installation (target "python_instrumentation").
The installation in this case is for the current user only, so that no privilege rights are required.

or

Run the command below from this folder:
python setup.py install --user (for current user only)
or
python setup.py install (for all users, it requires root privilege on Linux)

Profiling can be done:

With unmodified code: python -m palanteer [options] <your script>

This syntax is similar to the cProfile usage and no script modification is required.
By default, it tries to connect to a Palanteer server. With options, offline profiling can be selected.
Launch python -m palanteer for help or refer to the documentation.
With code instrumentation:

Please refer to the documentation for details.
Manual instrumentation can provide additional valuable information compared to just the automatic function profiling, like data, locks, ...