Learn how to develop custom integrations for Tracecat locally.
cd
into the custom-integrations-starter-kit
directory, add the following .pre-commit-config.yaml
file:
pre-commit-config.yaml
Create new repo
Install package and tracecat_registry
pyproject.toml
file.
To install it, run the following command:-e
flag installs the package in editable mode, which allows you to make changes to the package and have them reflected immediately.
The .[dev]
flag installs core and dev dependencies, which includes the tracecat
and tracecat_registry[cli]
Python packages.Find out more about the tracecat_registry
package below.Setup development environment
tracecat_registry
requires tracecat
to be installed.tracecat_registry
will give you access to the tc
CLI, which is used to validate your templates before syncing and running them in Tracecat.
It also includes the tracecat_registry
package, which contains necessary imports for building Tracecat Python UDFs.
registry.register
, Annotated
, Doc
, and RegistrySecret
are used to convert your Python function arguments into Tracecat action inputs.
They do not affect the function’s behavior in Python.
You can continue using the function as normal in your scripts and tests.
.env
file: