Permalink
Browse files

updated README

  • Loading branch information...
1 parent c7ef2d2 commit 3abdcdbf0f8e7db625ced017fdccea7175e14bdf Felix Richter committed Jan 19, 2011
Showing with 27 additions and 0 deletions.
  1. +27 −0 README.md
View
@@ -2,3 +2,30 @@ GENERICORE
==========
This is the python port of genericore, the generic information gathering
framework.
+
+Submodules
+==========
+Currently the python implementation has the following submodules
+
+* utils.py - a number of functions which define "common patterns" in all
+ genericore plugins (e.g. commandline parser or unique-id generator)
+ * parse\_default (argparse ) : adds default parser parameters
+ * generate\_unique (VERSION, config) : generates a unique id from the
+ Version number of the script and the configuration given
+* auto\_amqp.py - the amqp connector class which provides the following
+ functions:
+ * load\_conf - loads and merges configuration from the given dictionary
+
+ * load\_conf\_file - loads and merges configuration directly from a file
+
+ * create\_connection - starts the connection the the AMQP Server
+
+ * \_setup\_tubes - creates the in 'config' configured input and output
+ queues/exchanges
+ in addition it registers the following functions if input exchange is
+ defined:
+ * consume (callback) - calls amqp's basic\_consume with the correct
+ params
+ * start\_loop () - calls asyncore\_loop()
+ the following function is registered if the output exchange is defined
+ * publish (msg) - sends a message to the output exchange

0 comments on commit 3abdcdb

Please sign in to comment.