Hatchet Files

Overview

Added

• Adds hatchet.streams, a client for durable streams: topics that store messages independent of any run, which readers can resume from a cursor. publish (async) returns once a message is stored, keeps a client's messages to a topic in call order, and batches publishes queued behind an in-flight request (batch_timeout holds a message to gather more). Payloads over 4 MiB are uploaded over REST, up to 64 MiB. subscribe (an async iterator) reads a topic from the oldest retained message or a cursor, resubscribing from the last event read when the connection drops. reset / aio_reset start new readers after the latest message or a given cursor, and topic_metadata / aio_topic_metadata describe a topic's retained messages.

Documentation for agents

The linked pages serve plain markdown for tools and agents. Full docs index: https://docs.hatchet.run/llms.txt

Setup and local development:

• Quickstart: https://docs.hatchet.run/v1/quickstart.md
• Running Hatchet locally: https://docs.hatchet.run/v1/running-locally.md
• Embedded mode: https://docs.hatchet.run/v1/embedded.md

Core concepts:

• Tasks: https://docs.hatchet.run/v1/tasks.md
• Workers: https://docs.hatchet.run/v1/workers.md
• Running tasks: https://docs.hatchet.run/v1/running-your-task.md
• DAGs: https://docs.hatchet.run/v1/directed-acyclic-graphs.md
• Durable execution: https://docs.hatchet.run/v1/durable-execution.md

Flow control:

• Concurrency: https://docs.hatchet.run/v1/concurrency.md
• Rate limits: https://docs.hatchet.run/v1/rate-limits.md
• Retries: https://docs.hatchet.run/v1/retry-policies.md
• Idempotency: https://docs.hatchet.run/v1/idempotency.md
• CEL expressions: https://docs.hatchet.run/v1/cel-expressions.md

Python SDK reference (overview: https://docs.hatchet.run/reference/python.md):

• CEL: https://docs.hatchet.run/reference/python/feature-clients/cel.md (guide: https://docs.hatchet.run/v1/cel-expressions.md)
• Crons: https://docs.hatchet.run/reference/python/feature-clients/cron.md (guide: https://docs.hatchet.run/v1/cron-runs.md)
• Filters: https://docs.hatchet.run/reference/python/feature-clients/filters.md (guide: https://docs.hatchet.run/v1/events.md)
• Logs: https://docs.hatchet.run/reference/python/feature-clients/logs.md (guide: https://docs.hatchet.run/v1/logging.md)
• Metrics: https://docs.hatchet.run/reference/python/feature-clients/metrics.md (guide: https://docs.hatchet.run/v1/prometheus-metrics.md)
• Rate Limits: https://docs.hatchet.run/reference/python/feature-clients/rate_limits.md (guide: https://docs.hatchet.run/v1/rate-limits.md)
• Runs: https://docs.hatchet.run/reference/python/feature-clients/runs.md (guide: https://docs.hatchet.run/v1/running-your-task.md)
• Scheduled Runs: https://docs.hatchet.run/reference/python/feature-clients/scheduled.md (guide: https://docs.hatchet.run/v1/scheduled-runs.md)
• Streams: https://docs.hatchet.run/reference/python/feature-clients/streams.md
• Stubs: https://docs.hatchet.run/reference/python/feature-clients/stubs.md (guide: https://docs.hatchet.run/v1/inter-service-triggering.md)
• Webhooks: https://docs.hatchet.run/reference/python/feature-clients/webhooks.md (guide: https://docs.hatchet.run/v1/webhooks.md)
• Workers: https://docs.hatchet.run/reference/python/feature-clients/workers.md (guide: https://docs.hatchet.run/v1/workers.md)
• Workflows: https://docs.hatchet.run/reference/python/feature-clients/workflows.md (guide: https://docs.hatchet.run/v1/tasks.md)

Installation

Install the SDK using pip:

:::bash
pip install hatchet-sdk

Or using poetry:

:::bash
poetry add hatchet-sdk

Documentation

For detailed documentation, examples, and best practices, visit:

• Hatchet Documentation
• Examples

What's Changed?

• feat: add optional read-only API tokens (#5152) by @grutt
• feat(durable-streams): Go, Python, Ruby SDKs (#5348) by @juliusgeo