You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/changelog.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,14 @@ hide:
7
7
8
8
Full release notes for the Python SDK are available on [GitHub](https://github.com/taskbadger/taskbadger-python/releases).
9
9
10
+
## v2.6.0
11
+
12
+
**2026-08-11**
13
+
14
+
**Python SDK**
15
+
16
+
***CHANGED** API requests now [time out](python.md#request-timeout) after 5 seconds instead of never. Override with `init(timeout=...)` or the `TASKBADGER_HTTP_TIMEOUT` environment variable, which the [CLI](cli.md#environment-variables) also honours.
Copy file name to clipboardExpand all lines: docs/python.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ page in the [Task Badger dashboard](https://taskbadger.net).
34
34
| systems | System integrations such as [Celery](python-celery.md)|
35
35
| before_create | A function that is called before a task is created. See [Before Create Callback](#before-create-callback)|
36
36
| context_providers | Providers that attach extra data to a task when it errors. See [Error Context Providers](#error-context-providers)|
37
+
| timeout | Timeout for API requests. See [Request timeout](#request-timeout)|
37
38
| organization_slug | The organization identifier. Only required for legacy API keys. |
38
39
| project_slug | The project identifier. Only required for legacy API keys. |
39
40
@@ -43,6 +44,33 @@ If you attempt to use the SDK without configuring it you will get an error. To a
43
44
!!! tip
44
45
[Tags](data_model.md#tags) provided here will be applied to all tasks created using the SDK. If you need to add tags to individual tasks you can do so using the create and update methods or the `task.add_tag` method. Tags added manually will override the global tags.
45
46
47
+
### Request timeout
48
+
49
+
==Since v2.6.0==
50
+
51
+
API requests time out after 5 seconds. Override it with the `timeout` argument, in seconds:
52
+
53
+
```python
54
+
import taskbadger
55
+
56
+
taskbadger.init(token="YOUR_API_KEY", timeout=30)
57
+
```
58
+
59
+
The `TASKBADGER_HTTP_TIMEOUT` environment variable sets the default when `timeout` isn't passed,
60
+
and is also how you configure the timeout for the [CLI](cli.md#environment-variables).
61
+
62
+
For finer control pass an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/),
63
+
which lets you set the connect, read, write and pool timeouts separately:
0 commit comments