Quickstart

This quickstart gets you from zero to a working Engine template that can analyze a test artifact locally. You will clone the reference repo, install dependencies, run a known-good check, then run the test suite.

All instructions and examples assume that you are using a recent version of Linux and are building an Engine using Python with our reference implementation and associated artifact object library.

Our Python reference Engine implementation and Artifact object library should work in any current x86_64 Operating System.

Prerequisites

• Git
• Python (use the version supported by the template repo)
• A Python virtual environment (recommended)

Process

Step 1 - Cone

git clone https://github.com/polyswarm/microengine-webhooks-py.git

Step 2 - Install dependencies

Create and activate a virtual environment, then install the template in editable mode with the recommended extras.

python3 -m venv psvenv
source psvenv/bin/activate
pip install -U pip
pip install -e .[web,gunicorn,tests]

Step 3 - Run a known-good local check

Run the built-in analyzer checks. You should see a structured result containing a verdict and bid.

python -m microenginewebhookspy.engine analyze --check-eicar

Step 4 - Run tests

pytest -v

If this passes, you have a working Engine skeleton and test harness.

What you have now

You now have an Engine template that:

• Accepts a bounty object locally
• Runs an analyzer function
• Produces a valid assertion payload (verdict, bid, optional metadata)
• Has unit and integration tests you can build on