refactor(agent): port agent from script to python module

Author: azzamsa

.gitignore

@@ -1,6 +1,9 @@
 # Byte-compiled / optimized / DLL files
 __pycache__/
 
+# Distribution / packaging
+dist/
+
 # Docs
 _build/
 

agent/Dockerfile

@@ -1,26 +1,12 @@
 # didn't work with apline
 FROM python:3.11.3-slim-buster
 
-ENV PIP_DEFAULT_TIMEOUT=100
-
 RUN apt-get update
 # working with timezones
 RUN apt-get install --no-install-recommends --yes tzdata
 # confluent-kafka-python needs these
 RUN apt-get install --no-install-recommends --yes gcc librdkafka-dev python3-dev
 
-# upgrading pip solves many installation problems
-RUN pip3 install --upgrade pip
-
-WORKDIR /app
-
-# leverage Docker cache
-COPY requirements.lock ./
-RUN PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir -r requirements.lock
-
-ARG VCS_REVISION
-RUN echo "$VCS_REVISION" > ./version
-
-COPY src .
+RUN --mount=source=dist,target=/dist PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir /dist/*.whl
 
-CMD ["python3", "rkagent/main.py"]
+CMD ["python3", "-m", "rkagent"]

agent/justfile

@@ -19,6 +19,7 @@ check: fmt-check lint
 
 # Build the container image.
 image-build:
+    rye build --wheel --clean
     docker build --tag restknot-agent:latest --build-arg VCS_REVISION=$(git rev-parse --short HEAD) .
 
 # Run the container image.

agent/pyproject.toml

@@ -18,7 +18,6 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.rye]
-virtual = true
 managed = true
 dev-dependencies = [
     "pytest>=8.3.2",
@@ -29,4 +28,4 @@ dev-dependencies = [
 allow-direct-references = true
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/agent"]
+packages = ["src/rkagent"]

agent/requirements-dev.lock

@@ -9,10 +9,13 @@
 #   generate-hashes: false
 #   universal: false
 
+-e file:.
 confluent-kafka==2.0.2
+    # via rkagent
 iniconfig==2.0.0
     # via pytest
 libknot==3.2.5
+    # via rkagent
 packaging==24.1
     # via pytest
 pluggy==1.5.0
@@ -21,3 +24,4 @@ pytest==8.3.2
     # via pytest-mock
 pytest-mock==3.14.0
 pyyaml==6.0
+    # via rkagent

agent/requirements.lock

@@ -9,6 +9,10 @@
 #   generate-hashes: false
 #   universal: false
 
+-e file:.
 confluent-kafka==2.0.2
+    # via rkagent
 libknot==3.2.5
+    # via rkagent
 pyyaml==6.0
+    # via rkagent

agent/src/rkagent/__init__.py

@@ -1 +1,6 @@
-__version__ = "0.7.0"
+from rkagent import consumer
+
+
+def main() -> int:
+    consumer.main()
+    return 0

agent/src/rkagent/__main__.py

@@ -0,0 +1,4 @@
+import rkagent
+import sys
+
+sys.exit(rkagent.main())

agent/src/rkagent/main.py renamed to agent/src/rkagent/consumer.py

@@ -6,7 +6,7 @@
 
 from confluent_kafka import Consumer, KafkaException
 
-import knot
+from rkagent import knot
 
 logger = logging.getLogger(__name__)
 
@@ -73,7 +73,3 @@ def print_assignment(consumer, partitions):
     finally:
         # Close down consumer to commit final offsets.
         consumer.close()
-
-
-if __name__ == "__main__":
-    main()