Version 1.0.1 - updating the readme's and documentation

companionsKQML/__init__.py

@@ -2,12 +2,12 @@
 # @Author: Samuel Hill
 # @Date:   2020-02-10 15:30:23
 # @Last Modified by:   Samuel Hill
-# @Last Modified time: 2020-03-02 13:00:13
+# @Last Modified time: 2020-03-02 15:21:07
 
 """Package containing a low level Companions specific KQML server module as
 well as the Pythonian module for higher level KQML communication."""
 
-__version__ = '1.0'
+__version__ = '1.0.1'
 
 # from logging import basicConfig, INFO
 from .pythonian import Pythonian

docs/companionsKQML.companionsKQMLModule.html

@@ -8,7 +8,7 @@
 <td valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="companionsKQML.html"><font color="#ffffff">companionsKQML</font></a>.companionsKQMLModule</strong></big></big></font></td
 ><td align=right valign=bottom
-><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cqrg%5Ccompanions%5Cv1%5Cpythonian%5Ccompanionskqml%5Ccompanionskqml%5Ccompanionskqmlmodule.py">c:\qrg\companions\v1\pythonian\companionskqml\companionskqml\companionskqmlmodule.py</a></font></td></tr></table>
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Csamuel%20hill%5Cappdata%5Clocal%5Cprograms%5Cpython%5Cpython36-32%5Clib%5Csite-packages%5Ccompanionskqml%5Ccompanionskqmlmodule.py">c:\users\samuel hill\appdata\local\programs\python\python36-32\lib\site-packages\companionskqml\companionskqmlmodule.py</a></font></td></tr></table>
     <p><tt><a href="#CompanionsKQMLModule">CompanionsKQMLModule</a>,&nbsp;Override&nbsp;of&nbsp;<a href="kqml.kqml_module.html#KQMLModule">KQMLModule</a>&nbsp;for&nbsp;creation&nbsp;of&nbsp;Companions<br>
 agents.&nbsp;Adds&nbsp;a&nbsp;KQML&nbsp;socket&nbsp;server&nbsp;that&nbsp;is&nbsp;kept&nbsp;alive&nbsp;in&nbsp;a&nbsp;thread&nbsp;for<br>
 continuous&nbsp;communication&nbsp;between&nbsp;Companions&nbsp;and&nbsp;your&nbsp;python&nbsp;agents.<br>

docs/companionsKQML.html

@@ -8,7 +8,7 @@
 <td valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>companionsKQML</strong></big></big> (version 1.0)</font></td
 ><td align=right valign=bottom
-><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cqrg%5Ccompanions%5Cv1%5Cpythonian%5Ccompanionskqml%5Ccompanionskqml%5C__init__.py">c:\qrg\companions\v1\pythonian\companionskqml\companionskqml\__init__.py</a></font></td></tr></table>
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Csamuel%20hill%5Cappdata%5Clocal%5Cprograms%5Cpython%5Cpython36-32%5Clib%5Csite-packages%5Ccompanionskqml%5C__init__.py">c:\users\samuel hill\appdata\local\programs\python\python36-32\lib\site-packages\companionskqml\__init__.py</a></font></td></tr></table>
     <p><tt>Package&nbsp;containing&nbsp;a&nbsp;low&nbsp;level&nbsp;Companions&nbsp;specific&nbsp;KQML&nbsp;server&nbsp;module&nbsp;as<br>
 well&nbsp;as&nbsp;the&nbsp;Pythonian&nbsp;module&nbsp;for&nbsp;higher&nbsp;level&nbsp;KQML&nbsp;communication.</tt></p>
 <p>
@@ -27,8 +27,7 @@
 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 
 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
-<td width="100%"><strong>FORMAT_STRING</strong> = '%(levelname)s - %(asctime)s: %(name)s - %(message)s'<br>
-<strong>__authors__</strong> = 'Samuel Hill, Willie Wilson, and Joe Blass'<br>
+<td width="100%"><strong>__authors__</strong> = 'Samuel Hill, Willie Wilson, and Joe Blass'<br>
 <strong>__copyright__</strong> = 'Copyright 2020, Samuel Hill'<br>
 <strong>__email__</strong> = '[email protected]'<br>
 <strong>__license__</strong> = 'BSD-3-Clause'<br>

docs/companionsKQML.pythonian.html

@@ -8,7 +8,7 @@
 <td valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="companionsKQML.html"><font color="#ffffff">companionsKQML</font></a>.pythonian</strong></big></big></font></td
 ><td align=right valign=bottom
-><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cqrg%5Ccompanions%5Cv1%5Cpythonian%5Ccompanionskqml%5Ccompanionskqml%5Cpythonian.py">c:\qrg\companions\v1\pythonian\companionskqml\companionskqml\pythonian.py</a></font></td></tr></table>
+><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:c%3A%5Cusers%5Csamuel%20hill%5Cappdata%5Clocal%5Cprograms%5Cpython%5Cpython36-32%5Clib%5Csite-packages%5Ccompanionskqml%5Cpythonian.py">c:\users\samuel hill\appdata\local\programs\python\python36-32\lib\site-packages\companionskqml\pythonian.py</a></font></td></tr></table>
     <p><tt><a href="#Pythonian">Pythonian</a>&nbsp;agent,&nbsp;sits&nbsp;on&nbsp;top&nbsp;of&nbsp;the&nbsp;modified&nbsp;KQMLModule&nbsp;-<br>
 <a href="companionsKQML.companionsKQMLModule.html#CompanionsKQMLModule">CompanionsKQMLModule</a>.&nbsp;Uses&nbsp;subscription&nbsp;management&nbsp;classes&nbsp;to&nbsp;allow&nbsp;for&nbsp;cleaner<br>
 subscription&nbsp;polling&nbsp;and&nbsp;updating.<br>
@@ -300,6 +300,16 @@
 Args:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;argv&nbsp;(list,&nbsp;optional):&nbsp;argument&nbsp;list&nbsp;(typically&nbsp;from&nbsp;sys.argv)</tt></dd></dl>
 
+<hr>
+Static methods inherited from <a href="companionsKQML.companionsKQMLModule.html#CompanionsKQMLModule">companionsKQML.companionsKQMLModule.CompanionsKQMLModule</a>:<br>
+<dl><dt><a name="Pythonian-send_generic"><strong>send_generic</strong></a>(msg:kqml.kqml_performative.KQMLPerformative, out:_io.BufferedWriter)</dt><dd><tt>Basic&nbsp;send&nbsp;mechanism&nbsp;copied&nbsp;(more&nbsp;or&nbsp;less)&nbsp;from&nbsp;pykqml.&nbsp;Writes&nbsp;the<br>
+msg&nbsp;as&nbsp;a&nbsp;string&nbsp;to&nbsp;the&nbsp;output&nbsp;buffer&nbsp;then&nbsp;flushes&nbsp;it.<br>
+&nbsp;<br>
+Args:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;msg&nbsp;(KQMLPerformative):&nbsp;Message&nbsp;to&nbsp;be&nbsp;sent<br>
+&nbsp;&nbsp;&nbsp;&nbsp;out&nbsp;(BufferedWriter):&nbsp;The&nbsp;output&nbsp;to&nbsp;write&nbsp;to,&nbsp;needed&nbsp;for&nbsp;sending&nbsp;to<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Companions&nbsp;and&nbsp;sending&nbsp;on&nbsp;our&nbsp;own&nbsp;port.</tt></dd></dl>
+
 <hr>
 Methods inherited from <a href="kqml.kqml_module.html#KQMLModule">kqml.kqml_module.KQMLModule</a>:<br>
 <dl><dt><a name="Pythonian-error_reply"><strong>error_reply</strong></a>(self, msg, comment)</dt></dl>

setup.py

@@ -2,12 +2,12 @@
 # @Author: Samuel Hill
 # @Date:   2020-02-13 14:50:39
 # @Last Modified by:   Samuel Hill
-# @Last Modified time: 2020-03-02 15:07:32
+# @Last Modified time: 2020-03-02 15:21:05
 
 from setuptools import setup
 
 setup(name='companionsKQML',
-      version='1.0',
+      version='1.0.1',
       packages=['companionsKQML'],
       python_requires='>=3.0',
       install_requires=['pykqml>=1.1', 'psutil>=5.6.5',