From d823b50fc91635b85b0913377987938ff593d1d0 Mon Sep 17 00:00:00 2001 From: PatchOfScotland Date: Fri, 3 Feb 2023 16:24:54 +0100 Subject: [PATCH] added a very small readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee4572d..fc48fe1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # meow_base -Repository for base MEOW definitions +Repository for base MEOW definitions, as well as a some example implementations. + +## Core definitons + +The core MEOW defintions are found in **core/meow.py** These are parents classes for implementations to use, with certain attributes and functions enabling a certain amount of interchangeability within those classes. + +The most import definitions are the BasePattern, and BaseRecipe, which define the conditions under which processing will take place, and the actuall processing to take place. + +## MEOW Runner + +The way to run a MEOW system is to create and MeowRunner instance, found in **core/runner.py**. This will take 1 or more Monitors, 1 or more Handlers, and 1 or more Conductors. In turn, these will listen for events, respond to events, and execute any analysis identified. Examples of how this can be run can be found in **tests/testRunner.py** + +## Testing +Pytest unittests are provided within the 'tests directory, as well as a script **test_all.sh** for calling all test scripts from a single command. Individual test scripts can be started using: + + pytest test_runner.py::MeowTests -W ignore::DeprecationWarning + +with individual tests runnable with: + + pytest test_runner.py::MeowTests::testMeowRunnerLinkedPythonExecution -W ignore::DeprecationWarning