diff --git a/fink_client/consumer.py b/fink_client/consumer.py index e6182b5..cb73502 100644 --- a/fink_client/consumer.py +++ b/fink_client/consumer.py @@ -33,6 +33,10 @@ class AlertConsumer: def __init__(self, topics: list, config: dict, schema_path=None): """Creates an instance of `AlertConsumer` + Note we are currently using SASL for the user authentication. + `config` parameters get then translated for Kafka. + For lower level usage, see `_get_kafka_config` + Parameters ---------- topics : list of str @@ -244,6 +248,8 @@ def close(self): def _get_kafka_config(config: dict) -> dict: """Returns configurations for a consumer instance + Note we are using SASL for authentication (SCRAM-SHA-512). + Parameters ---------- config: dict