From edf6f2619e919be783834bf87ab7ba0f5e2f08f1 Mon Sep 17 00:00:00 2001 From: Mark Story Date: Fri, 13 Feb 2026 12:26:18 -0500 Subject: [PATCH] chore: Expand docs for releasing clients and client docs --- README.md | 13 ++++++++++++- clients/python/README.md | 5 +++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 79f08db5..860f446b 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ [![codecov](https://codecov.io/gh/getsentry/taskbroker/graph/badge.svg?token=RFA2pVkzhl)](https://codecov.io/gh/getsentry/taskbroker) Taskbroker provides a Kafka consumer, RPC interface, and inflight task storage -that form the core engine of asynchronous task execution at Sentry. +that form the core engine of asynchronous task execution at Sentry. This repository +also contains client libraries for python. ## High level overview @@ -93,3 +94,13 @@ make style # Fix formatting and lint issues make format ``` + +## Python Client + +See the [python client README](./clients/python/README.md) for more information. + +### Releasing clients + +1. Use the [release client libraries workflow](https://github.com/getsentry/taskbroker/actions/workflows/release-client.yml) +2. Choose 'Run workflow' and enter a version number in. +3. This will use craft + getsentry/publish to add packages to both internal and public pypi. diff --git a/clients/python/README.md b/clients/python/README.md index 28c658ef..daa72742 100644 --- a/clients/python/README.md +++ b/clients/python/README.md @@ -10,3 +10,8 @@ This package provides python client libraries for taskbroker. The client librari ## Example application You can find an example application in the `src/examples` directory. + +## Client documentation + +- [User-guide for taskbroker-client](https://develop.sentry.dev/backend/application-domains/tasks/) +- [Protobuf docs](https://getsentry.github.io/sentry-protos/sentry_protos.taskbroker.v1.html)