Metadata-Version: 2.4
Name: saluki
Version: 0.0.4
Project-URL: Homepage, https://github.com/ISISComputingGroup/saluki
Project-URL: Bug Reports, https://github.com/ISISComputingGroup/saluki/issues
Project-URL: Source, https://github.com/ISISComputingGroup/saluki
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ess-streaming-data-types
Requires-Dist: confluent-kafka
Requires-Dist: tzdata
Provides-Extra: dev
Requires-Dist: pyright; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Dynamic: license-file

![](https://github.com/ISISComputingGroup/saluki/blob/main/resources/logo.png)

Serialise/deserialise flatbuffers blobs from kafka. 
This currently deserialises https://github.com/ess-dmsc/python-streaming-data-types, but I am working to make it agnostic. Python bindings for the respective schema will need to be generated. 

# Usage
See `saluki --help` for all options. 

## Listen to a topic for updates
`saluki listen mybroker:9092/mytopic` - This will listen for updates for `mytopic` on `mybroker`. 

## Consume from a topic
`saluki consume mybroker:9092/mytopic -p 1 -o 123456 -m 10` - This will print 9 messages before (and inclusively the offset specified) offset `123456` of `mytopic` on `mybroker`, in partition 1.

Use the `-g` flag to go the other way, ie. in the above example to consume the 9 messages _after_ offset 123456

# Install 
`pip install saluki`

## Developer setup 
`pip install .[dev]`

