Installing the Client¶

This chapter describes how to install the accompanying Python library for FIRERPA. If you do not use Python, you can skip this chapter. Before you begin, please ensure that you have any version of Python from 3.6 to 3.12 installed on your computer. Then, please execute:

pip3 install -U lamda[full]

If the command above results in an error, please execute the version below. The difference is the addition of quotes, as it might be interpreted differently on various systems or Python versions. You can try both methods.

pip3 install -U 'lamda[full]'

Tip

Using the `-i` parameter to set the PIP source to a mirror closer to you, such as the USTC mirror, will greatly improve the installation speed.

Troubleshooting¶

After installation, you can run the command python3 -m lamda.client to check if it was installed correctly. If a UnicodeEncodeError: 'ascii' codec can't encode characters in... occurs, it is because your path contains Chinese characters, which gRPC cannot handle correctly. You can execute the following code to verify if this is the issue.

import sys
print (sys.path)

Note

If the output of `sys.path` contains one or more paths with Chinese characters, check your system environment variables, `PYTHONPATH`, or other Python-related environment variables, and remove the paths containing Chinese characters from them.

If you encounter other import errors like ImportError, please run the following command to force a reinstallation.

pip3 install -U --force-reinstall 'lamda[full]'

Tip

If these problems persist, we recommend creating and using a virtualenv.

Attention

After installation, you may need to use pip to update any third-party libraries that depend on frida, such as frida-tools, objection, etc. Otherwise, you may encounter subtle and hard-to-diagnose errors when using these tools later.