index.rst

Welcome to ezrules's documentation!

Ezrules is an open-source python package which aims to simplify business rule management and deployment for the fintech industry. It is a one stop solution that includes the following components:

1. UI for Business Analysts for easy rule writing, testing and deployment
2. Multiple extendable storage backends for easy rule life-cycle management: create rules and review their modification history
3. Scalable rule execution engine
4. Backtesting capabilities

A simple script is availble to get a ready-to-go infrastructure in AWS.

In development:

1. Easy A/B testing of multiple rule configurations
2. Automated rule parameters adjustment

Quick start

In order to deploy the infrastructure, from the root of the project run the following

./deployment/aws/deploy_all.sh environment_name

This command will do the following:

1. Create a bucket that will be used by the application
2. Package and upload lambda function code
3. Deploy a lambda function that will execute the business logic
4. Create UI application for analysts

Head over to Load balancers AWS page (make sure a correct region is set) to see the deployed endpoints. You may chose to point some of your sub-domains to load balancers so you have a permanent link to the deployed resources.

Two load balancers are deployed:

1. ezrules-alb-environment - points to the UI for analysts to write and create rules. See the :ref:`UI guide <usage-label>` for more details.
2. ezrules-evaluator-alb-environment - points to the API executing the business logic. See the :ref:`executor API description <executor_api>` for more details.

Indices and tables

• :ref:`whatsnew-label`
• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`