edx_event_bus_kafka package

Subpackages

• edx_event_bus_kafka.internal package
  • Subpackages
    • edx_event_bus_kafka.internal.tests package
      • Submodules
      • edx_event_bus_kafka.internal.tests.test_config module
      • edx_event_bus_kafka.internal.tests.test_consumer module
      • edx_event_bus_kafka.internal.tests.test_producer module
      • edx_event_bus_kafka.internal.tests.test_utils module
      • Module contents
  • Submodules
  • edx_event_bus_kafka.internal.config module
    • get_full_topic()
    • get_schema_registry_client()
    • load_common_settings()
  • edx_event_bus_kafka.internal.consumer module
    • EventConsumptionException
    • KafkaEventConsumer
      • KafkaEventConsumer.topic
      • KafkaEventConsumer.group_id
      • KafkaEventConsumer.consumer
      • KafkaEventConsumer.offset_time
      • KafkaEventConsumer.consume_indefinitely()
      • KafkaEventConsumer.determine_signal()
      • KafkaEventConsumer.emit_signals_from_message()
      • KafkaEventConsumer.record_event_consuming_error()
      • KafkaEventConsumer.reset_offsets_and_sleep_indefinitely()
    • ReceiverError
    • UnusableMessageError
    • get_deserializer()
  • edx_event_bus_kafka.internal.producer module
    • EventProductionException
    • KafkaEventProducer
      • KafkaEventProducer.prepare_for_shutdown()
      • KafkaEventProducer.send()
    • ProducingContext
      • ProducingContext.on_event_deliver()
    • create_producer()
    • descend_avro_schema()
    • extract_event_key()
    • extract_key_schema()
    • get_serializers()
    • get_signal_serializer()
    • poll_indefinitely()
    • record_producing_error()
  • edx_event_bus_kafka.internal.utils module
    • MessageHeader
      • MessageHeader.instances
    • get_message_header_values()
    • last_message_header_value()
  • Module contents
• edx_event_bus_kafka.management package
  • Subpackages
    • edx_event_bus_kafka.management.commands package
      • Submodules
      • edx_event_bus_kafka.management.commands.produce_event module
      • Module contents
  • Module contents

Submodules

edx_event_bus_kafka.apps module

edx_event_bus_kafka Django application initialization.

class edx_event_bus_kafka.apps.EdxEventBusKafkaConfig(app_name, app_module)

Bases: AppConfig

Configuration for the edx_event_bus_kafka Django application.

name = 'edx_event_bus_kafka'

edx_event_bus_kafka.models module

Database models for edx_event_bus_kafka.

edx_event_bus_kafka.urls module

URLs for edx_event_bus_kafka.

Module contents

Kafka implementation for Open edX event bus.

Public API will be in this module for the most part.

See ADR docs/decisions/0006-public-api-and-app-organization.rst for the reasoning.