Changelog
Full release notes for the Python SDK are available on GitHub.
v2.5.2
2026-08-07
Python SDK
- FIX
taskbadger_track=Falsenow opts a single Celery execution out of tracking, as anapply_asyncargument or in the message headers. Previously it could only ever enable tracking: it was ignored when theCelerySystemIntegrationwas auto-tracking, andapply_asyncoverwrote it on tasks usingbase=Task.
v2.5.1
2026-08-07
Python SDK
- CHANGED
list_tasksreturns aTaskListoftaskbadger.Taskobjects, which can be iterated over directly. It previously returned the generatedPaginatedTaskList, whoseresultswere internal models without the SDK's update methods. Note that an emptyTaskListis falsy, wherePaginatedTaskListwas always truthy. - FIX Eager Celery tasks honour an explicit
taskbadger_parent, includingtaskbadger_parent=Noneto opt out of nesting. - FIX Copying or pickling a
Taskno longer recurses until the stack overflows.
v2.5.0
2026-08-06
Python SDK
- NEW Parent and child tasks. Tasks can be nested one level deep via the
parentfield oncreate_task/update_task, andlist_taskscan filter by parent. The@trackdecorator, Celery and Procrastinate integrations set it automatically for tasks enqueued from within a tracked task. - NEW Context providers, a pluggable way to attach extra data to a task when it errors, along with a Sentry provider that links a failed task to its Sentry issue. Install with
pip install 'taskbadger[sentry]'. - NEW
Task.erroraccepts anexceptionargument, which is passed to the configured context providers.
v2.4.0
2026-07-30
Python SDK
- NEW
heartbeat_intervaloption for the Celery and Procrastinate integrations. The worker updates running tasks for you so that long-running tasks don't gostale. - FIX An eager Celery task no longer closes a Task Badger session opened by its caller.
v2.3.1
2026-07-27
Python SDK
- FIX Guard against unregistered task in
before_task_publishhandler.
v2.3.0
2026-07-23
Python SDK
- NEW The Celery and Procrastinate integrations now automatically record the originating task/job ID on the task
external_idfield.
v2.2.0
2026-07-09
Python SDK
- DEPRECATED Per-task actions are deprecated.
- HOUSEKEEPING Fix flaky Celery retry test.
v2.1.0
2026-07-08
Python SDK
- NEW Procrastinate integration for automatically tracking Procrastinate jobs, including periodic tasks. Install with
pip install 'taskbadger[procrastinate]'. - NEW Tasks now have a
queuefield, set automatically from the routing key (Celery) and task queue (Procrastinate). Also available oncreate_task/update_taskand the CLIcreate/updatecommands. - HOUSEKEEPING Dependency upgrades.
v2.0.0
2026-05-05
Python SDK
- BREAKING CLI dependencies (
typer,rich) are now an optional extra. Install withpip install 'taskbadger[cli]'(oruv tool install 'taskbadger[cli]') to use thetaskbadgercommand. SDK-only consumers no longer pull in these packages. Thetyperpin was also bumped from<0.10to>=0.12. - BREAKING Removed the deprecated
task.update_progressandtask.increment_progressmethods. Usetask.update_valueandtask.increment_valueinstead (deprecated since v1.6.1). - BREAKING Dropped support for Python 3.9. Minimum supported version is now Python 3.10.
v1.7.0
2026-02-16
Python SDK
- NEW Support for Project API Keys with automatic detection of organization and project from the key itself. The
organization_slug/project_slugarguments totaskbadger.initare no longer required when using a project key. - UPDATE Legacy API keys (which require explicit
organization_slugandproject_slug) now emit aDeprecationWarning. Migrate to Project API keys. - UPDATE The CLI
configurecommand now detects Project API keys and skips the organization/project prompts.
v1.6.3
2026-02-05
Python SDK
- NEW Track Celery canvas primitives (
map,starmap,chunks) so that inner tasks are recorded in Task Badger. More info in the Celery docs.
v1.6.2
2025-12-04
Python SDK
- HOUSEKEEPING Remove upper bound on httpx dependency
v1.6.1
2025-03-04
Python SDK
- UPDATE Deprecate
task.update_progressandtask.increment_progressin favour oftask.update_valueandtask.increment_value. - UPDATE Return boolean from
task.udpate_valueandtask.pingto indicate whether an update was made.
v1.6.0
2025-03-03
Python SDK
- NEW Add optional rate limiting for task updates when calling
task.pingandtask.update_progress
v1.5.0
2025-02-14
- NEW Tasks now support tagging. Tags are useful for categorizing tasks and filtering them in the UI. See Task Tags for more information.
Python SDK
- NEW Support for tagging.
- NEW
before_createcallback to allow modification of task data before it is created. This is useful for adding global tags and metadata to tasks such as the current tenant etc. See Before Create Callback for more information.
v1.4.0
2025-02-10
Python SDK
- NEW Add option to
CelerySystemIntegrationto automatically record Celery task arguments in task data.