https://github.com/gojek/courier-go
courier-go
https://github.com/gojek/courier-go
Last synced: 16 days ago
JSON representation
courier-go
- Host: GitHub
- URL: https://github.com/gojek/courier-go
- Owner: gojek
- License: mit
- Created: 2022-03-16T10:37:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T08:55:22.000Z (about 1 year ago)
- Last Synced: 2024-04-08T03:51:12.622Z (about 1 year ago)
- Language: Go
- Size: 1.4 MB
- Stars: 41
- Watchers: 9
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Courier Golang Client Library
[![build][build-workflow-badge]][build-workflow]
[![lint][lint-workflow-badge]][lint-workflow]
[![codecov][coverage-badge]][codecov]
[![docs][docs-badge]][pkg-dev]
[![go-report-card][report-badge]][report-card]
[![docs][docusaurus-badge]][gh-pages]
## Introduction
Courier Golang client library provides an opinionated wrapper over paho MQTT library to add features on top of it.
Head over to [Documentation][gh-pages] to get started.
Find the end-to-end courier example [here][e2e-example].
## Features
- Supports MQTT v3.1.1
- Flexible Encoder/Decoder support from Go type to MQTT payload conversion and back
- Middleware chaining
- [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-go) support
## Usage
```bash
go get -u github.com/gojek/courier-go
```
### Contributing Guide
Read our [contributing guide](./CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Courier Go Client.
### Release Process
This repo uses Golang [`submodules`](https://github.com/golang/go/wiki/Modules#faqs--multi-module-repositories), to make a new release, make sure to follow the release process described in [RELEASING](RELEASING.md) doc exactly.
## License
Courier Go Client is [MIT licensed](./LICENSE).
[build-workflow-badge]: https://github.com/gojek/courier-go/workflows/build/badge.svg
[build-workflow]: https://github.com/gojek/courier-go/actions?query=workflow%3Abuild
[lint-workflow-badge]: https://github.com/gojek/courier-go/workflows/lint/badge.svg
[lint-workflow]: https://github.com/gojek/courier-go/actions?query=workflow%3Alint
[coverage-badge]: https://codecov.io/gh/gojek/courier-go/branch/main/graph/badge.svg?token=QPLV2ZDE84
[codecov]: https://codecov.io/gh/gojek/courier-go
[docs-badge]: https://pkg.go.dev/badge/github.com/gojek/courier-go
[pkg-dev]: https://pkg.go.dev/github.com/gojek/courier-go
[report-badge]: https://goreportcard.com/badge/github.com/gojek/courier-go
[report-card]: https://goreportcard.com/report/github.com/gojek/courier-go
[docusaurus-badge]: https://img.shields.io/badge/Docs-latest-blue.svg
[gh-pages]: https://gojek.github.io/courier-go/
[e2e-example]: https://gojek.github.io/courier/docs/Introduction