Required kafka configurationproperties "bootstrap.servers": {streams_endpoint_url}:9094

For optional consumer configurations see: https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md

Client Authentication configuration
Replace example client authentication properties in the file client-authentication-config.json (https://github.com/Nasdaq/NasdaqCloudDataService-SDK-Python/blob/master/ncdssdk_client/src/main/python/resources/client-authentication-config.json) with valid credentials provided during on-boarding.

### Logging Configuration

To enable debug logging, edit the file (https://github.com/Nasdaq/NasdaqCloudDataService-SDK-Python/blob/master/ncdssdk/src/main/resources/logging.json)
and change the logging levels in whichever handler you would like output to go to.
For example, to enable debug logging to a file:

"loggers": { "": { "level": "DEBUG", "handlers": ["console", "file_handler"], "propogate": false } } }

Next, add a debug option to your kafka configurations:

### Create NCDS Session Client

How to run:

A few examples:

Get first 100 records for given stream

Get all available streams

## Using the SDK

Below are several examples for how to access data using the SDK. A Jupyter notebook with this same code and information is provided in the file

To run these examples, you will need the import and configuration dictionaries below. Replace the config information with your credentials.

security_cfg = { "oauth.token.endpoint.uri": "https://{auth_endpoint_url}/auth/realms/demo/protocol/openid-connect/token", "oauth.client.id": "client", "oauth.client.secret": "client-secret" } kafka_cfg = { "bootstrap.servers": "{streams_endpoint_url}:9094", "auto.offset.reset": "earliest" }

### Getting list of data stream available
  List all available data stream for the user

Example output:

### Getting schema for the stream
  This method returns the schema for the stream in Apache Avro format (https://avro.apache.org/docs/current/spec.html)

Example output:

### Get first 10 messages of the stream

Example output:

### Get first 10 messages of the stream from given timestamp
This returns the first 10 available messages of the stream given timestamp in milliseconds since the UNIX epoch.

Example output:

### Get example message from stream
Print message to the console for given message name.

Example output:

### Get continuous stream

ncds_client = NCDSClient(security_cfg, kafka_cfg) topic = "NLSPLUS-CTA-V4" consumer = ncds_client.ncds_kafka_consumer(topic) while True: messages = consumer.consume(num_messages=1, timeout=5) if len(messages) == 0: print(f"No Records Found for the Topic: {topic}") for message in messages: print(f"value :" + str(message.value()))

Example output:
note that only the first ten messages of the stream are shown in this example

### Example syntax to run the client based on this SDK

To list streams available on Nasdaq Cloud Data Service

2. To display the schema for the given topic

3. To dump top n records from the given topic

4. To use client based specific authorization file instead of using from the resources of client code base

5. To use the specific kafka properties instead of using the kafka properties from the resources of the client base code

6. To use the specific client based authorization file and specific kafka properties file

7. To display a specific message type

8. To dump top n records from the given topic from given timestamp in milliseconds since the UNIX epoch

9. To retrieve a continuous stream of messages from the given topic

10. To retrieve a stream of messages from the given topic, filtered by symbols or message names

## Documentation
An addition to the example application, there is extra documentation at the package and class level, which are located in project