Turning into proper Python package

Author: krrg

.idea/.gitignore

@@ -1,2 +1,29 @@
 # HAProxy SPOA
-This is a rudimentary, but functional implementation of a Stream Processing Offload Agent (SPOA) for HAProxy 1.8 and above, written in pure Python.
+A pure Python implementation of an HAProxy Stream Processing Offload Agent with asyncio support.
+
+This library handles the lower level details of the Stream Processing Offload Protocol, allowing quick implementation of custom agents.
+See the `example` folder for the full example, including an example HAProxy configuration.
+
+```python
+from ipaddress import IPv4Address
+
+from haproxyspoa.payloads.ack import AckPayload
+from haproxyspoa.spoa_server import SpoaServer
+
+agent = SpoaServer()
+
+
+@agent.handler("earth-to-mars")
+async def handle_earth_to_mars(src: IPv4Address, req_host: str):
+    return AckPayload().set_txn_var("src_echo", str(src) + req_host)
+
+
+if __name__ == "__main__":
+    agent.run(host='127.0.0.1', port=9002)
+```
+
+## TODO:
+* Add automated tests of our SPOP protocol implementation
+* Our target runtime was Python 3.8 or above, but it is possible this implementation could work with earlier versions.
+* Better debug logging / crash handling.
+* Document a recommended deployment strategy.

.idea/codeStyles/Project.xml

@@ -1,5 +1,6 @@
 import asyncio
 import functools
+import logging
 from collections import defaultdict
 from typing import List
 
@@ -34,10 +35,10 @@ async def handle_connection(self, reader: asyncio.StreamReader, writer: asyncio.
         await self.handle_hello_handshake(haproxy_hello_frame, writer)
 
         if HaproxyHelloPayload(haproxy_hello_frame.payload).healthcheck():
-            print("It is just a health check, immediately disconnecting")
+            logging.info("It is just a health check, immediately disconnecting")
             return
 
-        print("Completed new handshake with Haproxy")
+        logging.info("Completed new handshake with Haproxy")
 
         while True:
             frame = await Frame.read_frame(reader)
@@ -82,7 +83,7 @@ async def send_agent_disconnect(self, writer: asyncio.StreamWriter):
     async def handle_haproxy_disconnect(self, frame: Frame):
         payload = HaproxyDisconnectPayload(frame.payload)
         if payload.status_code() != DisconnectStatusCode.NORMAL:
-            print(f"Haproxy is disconnecting us with status code {payload.status_code()} - `{payload.message()}`")
+            logging.info(f"Haproxy is disconnecting us with status code {payload.status_code()} - `{payload.message()}`")
 
     async def handle_hello_handshake(self, frame: Frame, writer: asyncio.StreamWriter):
         agent_hello_frame = AgentHelloFrame(

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,26 @@
+import pathlib
+from setuptools import setup, find_packages
+
+README = (pathlib.Path(__file__).parent / "README.md").read_text()
+
+setup(
+    name="haproxyspoa",
+    version="0.0.1",
+    description="A pure-python asyncio implementation of an HAProxy Stream Processing Offload Agent (SPOA)",
+    long_description=README,
+    long_description_content_type="text/markdown",
+    url="https://github.com/krrg/haproxy-python-spoa",
+    author="Ken Reese",
+    author_email="[email protected]",
+    license="Apache 2",
+    classifiers=[
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3",
+        # "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+    ],
+    packages=find_packages(exclude=("example")),
+    # include_package_data=True,
+    install_requires=[],
+)