MInor doc update.

Author: git-steven

README.md

@@ -1,27 +1,11 @@
 # Python Bunny MQ
-Python-based package that implements a no-dependency, ultra-lightweight intra-process message queue.  This works inside a single process.  
+Python-based package that implements a no-dependency, ultra-lightweight intra-process message queue.  This works inside a single process, running in a separate thread.
+![](https://raw.githubusercontent.com/tangledpath/python-bunny-mq/master/bunny-sm.png)
+
 * This is useful when you need a lightweight pub-sub system.
-* For example, the author is using it in development to send messages to local handlers.  
-  * These handlers are ultimately deployed to AWS and are invoked as a lambda function via SQS, so the dev-time "bunny-mq" will not be used.
-  * In this case we use dependency injection to inject the correct MQ facade based on a `FAST_API_ENV` environment variable.
+* Introduce intra-process decoupling without running a separate service. 
 * It is backed by python's multiproducer, multiconsumer [queue](https://docs.python.org/3/library/queue.html).  
 
-<p>
-  <img src="https://raw.githubusercontent.com/tangledpath/python-bunny-mq/master/bunny.png" align="left" width="512"/>
-</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
-<p>&nbsp</p>
 
 ## Homepage
 https://pypi.org/project/python-bunny-mq/

docs/python_bunny_mq.html

@@ -60,48 +60,15 @@ <h1 class="modulename">
 
                         <div class="docstring"><h1 id="python-bunny-mq">Python Bunny MQ</h1>
 
-<p>Python-based package that implements a no-dependency, ultra-lightweight intra-process message queue.  This works inside a single process.  </p>
+<p>Python-based package that implements a no-dependency, ultra-lightweight intra-process message queue.  This works inside a single process, running in a separate thread.
+<img src="https://raw.githubusercontent.com/tangledpath/python-bunny-mq/master/bunny-sm.png" alt="" /></p>
 
 <ul>
 <li>This is useful when you need a lightweight pub-sub system.</li>
-<li>For example, the author is using it in development to send messages to local handlers. <br />
-<ul>
-<li>These handlers are ultimately deployed to AWS and are invoked as a lambda function via SQS, so the dev-time "bunny-mq" will not be used.</li>
-<li>In this case we use dependency injection to inject the correct MQ facade based on a <code>FAST_API_ENV</code> environment variable.</li>
-</ul></li>
+<li>Introduce intra-process decoupling without running a separate service. </li>
 <li>It is backed by python's multiproducer, multiconsumer <a href="https://docs.python.org/3/library/queue.html">queue</a>.  </li>
 </ul>
 
-<p>
-  <img src="https://raw.githubusercontent.com/tangledpath/python-bunny-mq/master/bunny.png" align="left" width="512"/>
-</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
-<p>&nbsp</p>
-
 <h2 id="homepage">Homepage</h2>
 
 <p><a href="https://pypi.org/project/python-bunny-mq/">https://pypi.org/project/python-bunny-mq/</a></p>

docs/python_bunny_mq/bunny_mq.html

@@ -77,7 +77,7 @@ <h1 class="modulename">
 </span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a>    <span class="k">try</span><span class="p">:</span>
 </span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">register_handler</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">,</span> <span class="n">foo_handler</span><span class="p">)</span>
 </span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
-</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">({</span><span class="s1">&#39;command&#39;</span><span class="p">:</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobar&quot;</span><span class="p">})</span>
+</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobar&quot;</span><span class="p">})</span>
 </span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a>    <span class="k">finally</span><span class="p">:</span>
 </span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 </span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a>
@@ -103,8 +103,8 @@ <h1 class="modulename">
 </span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a>    <span class="k">try</span><span class="p">:</span>
 </span><span id="L-43"><a href="#L-43"><span class="linenos">43</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">register_handler</span><span class="p">(</span><span class="n">BunnyMQ</span><span class="o">.</span><span class="n">WILDCARD_HANDLER</span><span class="p">,</span> <span class="n">wildcard_handler</span><span class="p">)</span>
 </span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
-</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">({</span><span class="s1">&#39;command&#39;</span><span class="p">:</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;barfood&quot;</span><span class="p">})</span>
-</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">({</span><span class="s1">&#39;command&#39;</span><span class="p">:</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobard&quot;</span><span class="p">})</span>
+</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;barfood&quot;</span><span class="p">})</span>
+</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobard&quot;</span><span class="p">})</span>
 </span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a>    <span class="k">finally</span><span class="p">:</span>
 </span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 </span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a>
@@ -143,7 +143,7 @@ <h1 class="modulename">
 </span><span id="test_simple_message-17"><a href="#test_simple_message-17"><span class="linenos">17</span></a>    <span class="k">try</span><span class="p">:</span>
 </span><span id="test_simple_message-18"><a href="#test_simple_message-18"><span class="linenos">18</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">register_handler</span><span class="p">(</span><span class="s2">&quot;foo&quot;</span><span class="p">,</span> <span class="n">foo_handler</span><span class="p">)</span>
 </span><span id="test_simple_message-19"><a href="#test_simple_message-19"><span class="linenos">19</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
-</span><span id="test_simple_message-20"><a href="#test_simple_message-20"><span class="linenos">20</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">({</span><span class="s1">&#39;command&#39;</span><span class="p">:</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobar&quot;</span><span class="p">})</span>
+</span><span id="test_simple_message-20"><a href="#test_simple_message-20"><span class="linenos">20</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobar&quot;</span><span class="p">})</span>
 </span><span id="test_simple_message-21"><a href="#test_simple_message-21"><span class="linenos">21</span></a>    <span class="k">finally</span><span class="p">:</span>
 </span><span id="test_simple_message-22"><a href="#test_simple_message-22"><span class="linenos">22</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 </span><span id="test_simple_message-23"><a href="#test_simple_message-23"><span class="linenos">23</span></a>
@@ -186,8 +186,8 @@ <h1 class="modulename">
 </span><span id="test_wildcard_handler-43"><a href="#test_wildcard_handler-43"><span class="linenos">43</span></a>    <span class="k">try</span><span class="p">:</span>
 </span><span id="test_wildcard_handler-44"><a href="#test_wildcard_handler-44"><span class="linenos">44</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">register_handler</span><span class="p">(</span><span class="n">BunnyMQ</span><span class="o">.</span><span class="n">WILDCARD_HANDLER</span><span class="p">,</span> <span class="n">wildcard_handler</span><span class="p">)</span>
 </span><span id="test_wildcard_handler-45"><a href="#test_wildcard_handler-45"><span class="linenos">45</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
-</span><span id="test_wildcard_handler-46"><a href="#test_wildcard_handler-46"><span class="linenos">46</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">({</span><span class="s1">&#39;command&#39;</span><span class="p">:</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;barfood&quot;</span><span class="p">})</span>
-</span><span id="test_wildcard_handler-47"><a href="#test_wildcard_handler-47"><span class="linenos">47</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">({</span><span class="s1">&#39;command&#39;</span><span class="p">:</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobard&quot;</span><span class="p">})</span>
+</span><span id="test_wildcard_handler-46"><a href="#test_wildcard_handler-46"><span class="linenos">46</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;barfood&quot;</span><span class="p">})</span>
+</span><span id="test_wildcard_handler-47"><a href="#test_wildcard_handler-47"><span class="linenos">47</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;body&#39;</span><span class="p">:</span> <span class="s2">&quot;foobard&quot;</span><span class="p">})</span>
 </span><span id="test_wildcard_handler-48"><a href="#test_wildcard_handler-48"><span class="linenos">48</span></a>    <span class="k">finally</span><span class="p">:</span>
 </span><span id="test_wildcard_handler-49"><a href="#test_wildcard_handler-49"><span class="linenos">49</span></a>        <span class="n">bunny</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
 </span><span id="test_wildcard_handler-50"><a href="#test_wildcard_handler-50"><span class="linenos">50</span></a>

docs/python_bunny_mq/test_bunny_queue.html

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-bunny-mq"
-version = "0.1.6"
+version = "0.1.8"
 description = "Ultra-lightweight (no-dependency) message queue for intra-process pub-sub communication."
 authors = ["Steven Miers <steven.miers@gmail.com>"]
 license = "THE UNLICENSE"

docs/search.js

@@ -58,17 +58,18 @@ def __init__(self, name: str = DEFAULT_NAME, timeout: float = 1.0, interval: flo
         self.processed_count = 0
         self.processed_events = BoundedDict()
 
-    def send_message(self, message: Dict[str, Any]):
+    def send_message(self, command:str, message: Dict[str, Any]) -> Dict[str, Any]:
         """ Stores a message in the queue, to processed by any registered handlers"""
-        logger.info(f"Sending message: {message}", {"name": self.name})
+        logger.info(f"Sending message[{command}]: {message}", {"name": self.name})
         result = None
         if self.stopping:
             logger.info(f"Queue is stopped; blocking message: {message}", {
                 "name": self.name
             })
         else:
-            message_id = uuid.uuid4()
+            message_id = str(uuid.uuid4())
             metadata = {
+                'command': command,
                 'MD5OfMessageBody': hashlib.md5(json.dumps(message).encode()).hexdigest(),
                 'MessageId': message_id,
                 'SequenceNumber': self.sequence_number
@@ -118,7 +119,7 @@ def handle_message(self):
             message: Dict[str, Any] = full_event["message"]
             metadata: Dict[str, Any] = full_event["metadata"]
 
-            message_cmd = message.get("command", None)
+            message_cmd = metadata.get("command", None)
             processed = False
             if message_cmd:
                 handlers = self.handlers.get(message_cmd, None)

pyproject.toml

@@ -16,7 +16,7 @@ def foo_handler(message):
     try:
         bunny.register_handler("foo", foo_handler)
         bunny.start()
-        bunny.send_message({'command': 'foo', 'body': "foobar"})
+        bunny.send_message(command='foo', message={'body': "foobar"})
     finally:
         bunny.stop()
 
@@ -42,13 +42,13 @@ def wildcard_handler(message):
     try:
         bunny.register_handler(BunnyMQ.WILDCARD_HANDLER, wildcard_handler)
         bunny.start()
-        bunny.send_message({'command': 'bar', 'body': "barfood"})
-        bunny.send_message({'command': 'foo', 'body': "foobard"})
+        bunny.send_message(command='foo', message={'body': "barfood"})
+        bunny.send_message(command='bar', message={'body': "foobard"})
     finally:
         bunny.stop()
 
     assert handled == 2
     assert len(bunny) == 0
     assert bunny.sequence_number == 2
     assert bunny.processed_count == 2
-    assert len(bunny.processed_events) == 2
+    assert len(bunny.processed_events) == 2