Skip to content

Commit

Permalink
add interim logo and plugin writing info
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Miller <[email protected]>
  • Loading branch information
maxamillion committed Jul 20, 2016
1 parent f0fade0 commit 978e5d6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
loopabull
=========

.. image:: images/loopable.png

NOTE: THIS IS PRE-ALPHA QUALITY AT THIS TIME - UNDER HEAVY DEVELOPMENT
======================================================================

Expand Down Expand Up @@ -95,6 +97,9 @@ supported.
plugin: fedmsg
Current list of available plugins:
* fedmsg

ansible
-------

Expand All @@ -110,9 +115,30 @@ Provide some information about ansible. Currently we need ``inventory_path`` and
Writing Plugins
===============

.. FIXME
Something to note is that in Loopabull, plugins are internally called "loopers"
for no real reason other than to isolate the namespace so that we don't collide
with the modules uses as data providers to the plugins.

As such, plugins shall be named ``${PLUGIN_NAME}looper.py`` and implement
a class named ``${PLUGIN_NAME_CAPITALIZED}Looper``

Example below (filename ``examplelooper.py``:

.. code-block:: python
from loopabull.plugin import Plugin
class ExampleLooper(Plugin):
def __init__(self):
self.key = "ExampleLooper"
super(ExampleLooper, self).__init__(self)
def looper(self):
# A python generator implementation
yield (router_key, dict(data))
TODO
Note that the configuration file entry for this will simply be "example" and the
rest of the mapping of the plugin to it's namespace is handled internally.

Hacking / Example
=================
Expand Down
Binary file added images/loopabull.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 978e5d6

Please sign in to comment.