Installation

Installing on Linux/Mac

FunctionTrace comes in two necessary pieces: a server, and a language-specific client.

Note: It's currently necessary to have cargo installed in order to install FunctionTrace, as functiontrace-server is not packaged for all supported operating systems. You can install cargo via rustup.

# Install the server
$ cargo install functiontrace-server

# Install the Python client
$ pip install functiontrace

Installing with Nix

If you use Nix, you can easily try a recent version of FunctionTrace with nix shell or install it via python312Packages.functiontrace (or any other desired Python version).

# Local testing (Flakes + new CLI)
$ export NIXPKGS_ALLOW_UNFREE=1
$ nix shell --impure nixpkgs#python312Packages.functiontrace

# Local testing (no Flakes)
$ export NIXPKGS_ALLOW_UNFREE=1
$ nix-shell --impure -p python312Packages.functiontrace

Installing on Windows

FunctionTrace is not currently supported on Windows. Contact support@functiontrace.com if you wish to fund development.

Learn how to use FunctionTrace

Now that FunctionTrace is installed, it's time to learn how to use it.

Using Functiontrace