2.1.1 (#44)

* Update confluent-kafka to 2.1.0

* Split dependencies into extra packages

* Install librdkafka-dev in generate docs workflow

* Update to 2.1.1

Author: robooo

.github/workflows/generate_docs.yml

@@ -13,11 +13,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'
-    - name: Install python requirements
+    # This latest python way can't find the librdkafka.h files
+    # - name: Set up Python
+    #   uses: actions/setup-python@v4
+    #   with:
+    #     python-version: '3.x'
+    - name: Install requirements
       run: pip install .
     - name: Generate keyword documentation
       run: python3 -m robot.libdoc -f html src/ConfluentKafkaLibrary docs/index.html

.github/workflows/main.yml

@@ -28,11 +28,13 @@ jobs:
       - name: Spin up kafka
         run: cd examples && docker-compose up -d && cd ..
       - name: Install python requirements
-        run: pip install .
+        run: pip install .[all]
       - name: Wait for services
         run: while [ -n "$(docker container ls -a | grep starting)" ]; do sleep 2; done;
       - name: Docker inspect
         run:  docker inspect --format "{{json .State.Health.Status }}" $(docker-compose -f examples/docker-compose.yml ps -q)
+      - name: Show python version
+        run: python3 --version
       - name: Execute tests
         run: python3 -m robot -d ./docs examples/
         continue-on-error: true

README.md

@@ -22,6 +22,17 @@ To install the library, run the following command:
 pip install robotframework-confluentkafkalibrary
 ```
 
+Extra packages:
+* [avro] = ['fastavro >= 1.3.2', 'avro-python3 >= 1.10.1']
+* [json] = ['jsonschema >= 3.2.0']
+* [protobuf] = ['protobuf >= 4.22.0']
+
+To install all dependencies use `[all]` extension like:
+
+```
+pip install robotframework-confluentkafkalibrary[all]
+```
+
 ## Usage
 
 In most cases, you can refer to the [confluent-kafka-python documentation](https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html) for guidance. Every keyword in ConfluentKafkaLibrary is designed to match the corresponding Python functions. If you are unsure about the pre-configured keywords, please visit the  [robotframework-ConfluentKafkaLibrary documentation](https://robooo.github.io/robotframework-ConfluentKafkaLibrary/). The Kafka team maintains the up-to-date documentation for configuration properties and their values [here](https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md).

setup.py

@@ -10,6 +10,10 @@
 Confluent Kafka wrapped in Robot Framework.
 """[1:-1]
 
+AVRO_REQUIRES = ['fastavro >= 1.3.2', 'avro-python3 >= 1.10.1']
+JSON_REQUIRES = ['jsonschema >= 3.2.0']
+PROTO_REQUIRES = ['protobuf >= 4.22.0']
+ALL = AVRO_REQUIRES + JSON_REQUIRES + PROTO_REQUIRES
 setup(name         = 'robotframework-confluentkafkalibrary',
       version      = VERSION,
       description  = 'Confluent Kafka library for Robot Framework',
@@ -28,13 +32,15 @@
       ],
       install_requires = [
           'robotframework >= 3.2.1',
-          'confluent-kafka == 2.0.2',
+          'confluent-kafka == 2.1.1',
           'requests >= 2.25.1',
-          'avro-python3 >= 1.10.1',
-          'fastavro >= 1.3.2',
-          'jsonschema >= 3.2.0',
-          'protobuf >= 4.22.0'
       ],
+      extras_require={
+          'all': ALL,
+          'avro': AVRO_REQUIRES,
+          'json': JSON_REQUIRES,
+          'protobuf': PROTO_REQUIRES,
+      },
       package_dir  = {'' : 'src'},
-      packages    = ['ConfluentKafkaLibrary'],
+      packages     = ['ConfluentKafkaLibrary'],
       )

src/ConfluentKafkaLibrary/__init__.py

@@ -3,16 +3,20 @@
 from confluent_kafka.schema_registry import SchemaRegistryClient
 from confluent_kafka.admin import AdminClient, NewTopic, NewPartitions, ConfigResource
 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
-
 from .consumer import KafkaConsumer
 from .producer import KafkaProducer
 from .admin_client import KafkaAdminClient
-from .serialization import Serializer, Deserializer
 from .version import VERSION
 
+IMPORTS = KafkaConsumer, KafkaProducer, KafkaAdminClient
+try:
+    from .serialization import Serializer, Deserializer
+    IMPORTS += Serializer, Deserializer
+except ImportError:
+    pass
 
 #class ConfluentKafkaLibrary(KafkaConsumer, KafkaProducer, Serializer, Deserializer):
-class ConfluentKafkaLibrary(KafkaConsumer, KafkaProducer, KafkaAdminClient, Serializer, Deserializer):
+class ConfluentKafkaLibrary(*IMPORTS):
     """ConfluentKafkaLibrary is a Robot Framework library which wraps up
     [https://github.com/confluentinc/confluent-kafka-python | confluent-kafka-python].
     Library supports more functionality like running more clients based on `group_id`
@@ -89,7 +93,7 @@ def _set_globals_variables_if_robot_running(self):
             BuiltIn().set_global_variable('${ADMIN_RESOURCE_GROUP}', confluent_kafka.admin.RESOURCE_GROUP)
             BuiltIn().set_global_variable('${ADMIN_RESOURCE_TOPIC}', confluent_kafka.admin.RESOURCE_TOPIC)
 
-            BuiltIn().set_global_variable('${CONSUMER_GROUP_STATE_UNKNOWN}', confluent_kafka.ConsumerGroupState.UNKOWN)
+            BuiltIn().set_global_variable('${CONSUMER_GROUP_STATE_UNKNOWN}', confluent_kafka.ConsumerGroupState.UNKNOWN)
             BuiltIn().set_global_variable('${CONSUMER_GROUP_STATE_PREPARING_REBALANCING}', confluent_kafka.ConsumerGroupState.PREPARING_REBALANCING)
             BuiltIn().set_global_variable('${CONSUMER_GROUP_STATE_COMPLETING_REBALANCING}', confluent_kafka.ConsumerGroupState.COMPLETING_REBALANCING)
             BuiltIn().set_global_variable('${CONSUMER_GROUP_STATE_STABLE}', confluent_kafka.ConsumerGroupState.STABLE)

src/ConfluentKafkaLibrary/consumer.py

@@ -2,10 +2,14 @@
 from threading import Thread
 from confluent_kafka import Consumer, KafkaException, KafkaError, TopicPartition
 from confluent_kafka import DeserializingConsumer
-from confluent_kafka.avro.serializer import SerializerError
-from confluent_kafka.avro import AvroConsumer
 from confluent_kafka.admin import AdminClient
 
+try:
+    from confluent_kafka.avro.serializer import SerializerError
+    from confluent_kafka.avro import AvroConsumer
+except ImportError:
+    pass
+
 
 class GetMessagesThread(Thread):
 

src/ConfluentKafkaLibrary/producer.py

@@ -1,11 +1,14 @@
 import uuid
 import os
-from avro import schema
 from confluent_kafka import SerializingProducer
 from confluent_kafka import Producer
-from confluent_kafka import avro
-from confluent_kafka.avro import AvroProducer
 
+try:
+    from avro import schema
+    from confluent_kafka import avro
+    from confluent_kafka.avro import AvroProducer
+except ImportError:
+    pass
 
 class KafkaProducer():
 

src/ConfluentKafkaLibrary/version.py

@@ -1 +1 @@
-VERSION = '2.0.2-4'
+VERSION = '2.1.1-1'