ruleau 0.4.2

A python rules engine

Ruleau

A Python Rules Engine library

Using the library

A username and password is required. This can be passed directly to the ApiAdapter (i.e. via the CLI) or these can be set in the environment variables.

RULEAU_USERNAME=myusername
RULEAU_PASSWORD=mypassword

from ruleau import execute, rule, ApiAdapter

# create a rule
@rule(rule_id="rul_1", name="Is adult")
def over_18(_, payload):
    return "age" in payload and payload["age"] >= 18

# create a payload (the answers to the rule's questions)
payload = {"age": 17}

# execute the rule against the payload
result = execute(over_18, payload)

# integrate with the backend web API with password and username in env
api_adapter = ApiAdapter(base_url="http://localhost:8000/")
# or pass directly to ApiAdapter:
api_adapter = ApiAdapter(base_url="http://localhost:8000/", username=myusername, password=mypassword)

# send the results
result = execute(
    over_18, payload, api_adapter=api_adapter, case_id="ca_1280"
)
# result.result will be False due to applicant being 17

# if the rule for this case is overriden in the backend
# then running again will return True

Testing Rules

Rules should be tested using doctest.

Example of these tests can be found in the Kitchen Sink example.

Generating Documentation

Documentation for the rules can be generated using the ruleau-docs command.

The usage is as follows:

ruleau-docs [--output-dir=<argument>] filename

For example for a file of rules called rules.py run:

ruleau-docs rules.py

Building & Testing the Library

Pre-requisites

• Python 3.9+

Package requirements installed by running:

pip install -r requirements-dev.txt

Running the Tests

To run all unit tests in the project use the following command:

pytest