Installation

caterpillar does not have a direct Python installation candidate. Therefore, you will need to install it by providing the Git link. This library has no fixed dependencies, so it can run out of the box.

There are several installation options you can use to install a desired part of the library. caterpillar ships with a native C extension and additional tools. As not everyone wants to use C extensions, it’s default installation candidate does not include the native extension.

pip install git+https://github.com/MatrixEditor/caterpillar.git

Note

If you clone the repository, don’t forget to add -e to the installation via pip as it enables developer mode.

If you want to use the native C extension you can specify the following environment variables:

• CP_ENABLE_NATIVE - Enables installation of the native C extension

• CP_ENABLE_TOOLS - Enables installation of extra tools (proposed)

or you can use the following command to install it directly:

pip install git+https://github.com/MatrixEditor/caterpillar/#subdirectory=src/ccaterpillar

This project comes with packaging extras. Therefore, if you want to enable specific structs, you have to install the corresponding extra. It can be done using pip again:

pip install "caterpillar[$NAME]@git+https://github.com/MatrixEditor/caterpillar.git"

where $NAME refers to

• lzo: for LZO compression support

• crypt: for extended encryption/decryption support

• all: to simply install all optional dependencies

Tip

If you wish to contribute to this project, make sure you follow the Contribution Guidelines. This library is especially designed for Python 3.12 and prior versions are still subject to approval.