From 6947ae3cad4ebf03e314218e0434ab4786bc3211 Mon Sep 17 00:00:00 2001 From: Einar Lanfranco Date: Sat, 26 Nov 2022 14:00:12 -0300 Subject: [PATCH] Some modifications made to developer guide and a new noop collector bot example added --- DEVELOP-GUIDE.md | 5 +++-- example_bots/BOTS | 17 ----------------- example_bots/bots/collectors/noop/collector.py | 2 +- .../bots/collectors/otherexample/collector.py | 0 example_bots/bots/experts/example/expert.py | 14 -------------- 5 files changed, 4 insertions(+), 34 deletions(-) delete mode 100644 example_bots/BOTS delete mode 100644 example_bots/bots/collectors/otherexample/collector.py delete mode 100644 example_bots/bots/experts/example/expert.py diff --git a/DEVELOP-GUIDE.md b/DEVELOP-GUIDE.md index 262f494..04b4014 100644 --- a/DEVELOP-GUIDE.md +++ b/DEVELOP-GUIDE.md @@ -41,7 +41,7 @@ Docker dev shares almost all volumes and environment variables from intelmq-full ### Add your own bots -Just start coding or pull your bots repository in some folder like ./my_bots in a subfolder bots, so you need for example my_bots/bots/[collectors,parsers,experts,output,parsers] +Just start coding or pull your bots repository in some folder like, for example, ./my_bots in a subfolder bots, then you have for example my_bots/bots/[collectors,parsers,experts,output,parsers] You could take a look at the folder and files in https://github.com/certtools/intelmq/tree/develop/intelmq/bots to start. @@ -62,7 +62,8 @@ docker-compose exec -f docker-compose-dev.yml intelmq sudo bash /opt/install_req When you do this: -* Yours bots REQUERIMENTS.txt and yout bots will be installed or updated from **MY_FORK** +* Yours bots REQUERIMENTS.txt and yout bots will be installed or updated from **MY_FORK**. +* Keep in mind that before being installed they will be mixed with the originals of the intelmq project, so it is important not to use the same names, neither for the bot nor for the .py files. ## Dependencies problems diff --git a/example_bots/BOTS b/example_bots/BOTS deleted file mode 100644 index feaa198..0000000 --- a/example_bots/BOTS +++ /dev/null @@ -1,17 +0,0 @@ -{ - "Collector": { - }, - "Parser": { - }, - "Expert": { - "Example": { - "description": "Example own bot.", - "module": "intelmq.bots.experts.example.expert", - "parameters": { - } - } - }, - "Output": { - - } -} diff --git a/example_bots/bots/collectors/noop/collector.py b/example_bots/bots/collectors/noop/collector.py index 2aa6a35..c9b5f22 100644 --- a/example_bots/bots/collectors/noop/collector.py +++ b/example_bots/bots/collectors/noop/collector.py @@ -30,4 +30,4 @@ class NoOpCollectorBot(CollectorBot): self.send_message(report) -BOT = NoOpCollectorBot \ No newline at end of file +BOT = NoOpCollectorBot diff --git a/example_bots/bots/collectors/otherexample/collector.py b/example_bots/bots/collectors/otherexample/collector.py deleted file mode 100644 index e69de29..0000000 diff --git a/example_bots/bots/experts/example/expert.py b/example_bots/bots/experts/example/expert.py deleted file mode 100644 index c39a6e2..0000000 --- a/example_bots/bots/experts/example/expert.py +++ /dev/null @@ -1,14 +0,0 @@ -# -*- coding: utf-8 -*- -from intelmq.lib.bot import Bot - - -class ExampleExpertBot(Bot): - - def init(self): - pass - - def process(self): - pass - - -BOT = ExampleExpertBot