Skip to content

Repository files navigation

Quix - React to data, fast

Quix on Twitter The Stream Community Slack Linkedin Events YouTube

Quix Streams for .NET

Quix Streams for .NET is a Kafka streaming client library used mainly for Quix internal platform needs and existing .NET integrations.

This repository is in maintenance mode. It remains published because it is still useful for .NET services that need to produce or consume Quix Streams-compatible data, but Quix's primary open source focus is now the Python library:

Use quixio/quix-streams for new Quix Streams projects.

The Python library is where active feature development happens first. No major new work is expected in this .NET repository, but we aim to keep it updated for internal platform needs and community contributions.

When to Use This Library

Use this package if you:

  • Have an existing .NET application using Quix Streams.
  • Need a C# producer or consumer for Quix Streams-compatible Kafka data.
  • Are integrating with Quix platform services that already depend on this library.
  • Need lower-level Kafka transport building blocks. The library includes practical handling for Kafka edge cases found in production use, and other libraries can be built on top of QuixStreams.Kafka.Transport.
  • Want the convenience APIs in QuixStreams.Streaming or telemetry helpers for working with Kafka messages in .NET.

For complex stream processing or new stream processing applications, start with the Python library instead: github.com/quixio/quix-streams.

Install

Install the .NET package from NuGet:

QuixStreams.Streaming

Documentation

The documentation in this repository is retained for existing .NET users:

Some docs may describe the broader Quix Streams model rather than the current direction of this repository. For current Quix Streams development, use the Python project: quixio/quix-streams.

Compatibility

This library is intended to remain compatible with Quix Streams data produced and consumed by Quix platform services and the primary Python library where applicable. Compatibility work is driven by platform needs, maintenance, and community contributions rather than a separate .NET feature roadmap.

Using Quix Streams with Quix Cloud

This library does not require a commercial product. When used with the Quix platform, it can integrate with Quix-managed Kafka, configuration, monitoring, data exploration, pipeline visualization, and related platform workflows.

Contributing

Community feedback and fixes are welcome, especially for bugs, compatibility issues, and documentation improvements. Before opening a larger PR, please create an issue so we can discuss whether the change fits the maintenance scope of this repository.

Read the Contributing Guide for local development and PR guidance.

Need Help?

If you run into a problem, ask in The Stream Slack community or create an issue in this repository.

For help with new Quix Streams projects, please start with the Python library: github.com/quixio/quix-streams.

Community

Join other software engineers in The Stream Slack community, an online community for people interested in data streaming.

You can also follow Quix on Twitter, LinkedIn, and YouTube.

License

Quix Streams for .NET is licensed under the Apache 2.0 license. See LICENSE.

About

Dotnet implementation of Quix Streams

Resources

Code of conduct

Contributing

Stars

9 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages