Skip to content

Commit f3c9e77

Browse files
committed
update changelog and docs for v1.7.0 and v2.0.0
1 parent 2a808e6 commit f3c9e77

2 files changed

Lines changed: 31 additions & 4 deletions

File tree

docs/changelog.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,26 @@ hide:
55

66
# Changelog
77

8+
## v2.0.0
9+
10+
**2026-05-05**
11+
12+
**Python SDK**
13+
14+
* **BREAKING** CLI dependencies (`typer`, `rich`) are now an optional extra. Install with `pip install 'taskbadger[cli]'` (or `uv tool install 'taskbadger[cli]'`) to use the `taskbadger` command. SDK-only consumers no longer pull in these packages. The `typer` pin was also bumped from `<0.10` to `>=0.12`.
15+
* **BREAKING** Removed the deprecated `task.update_progress` and `task.increment_progress` methods. Use `task.update_value` and `task.increment_value` instead (deprecated since v1.6.1).
16+
* **BREAKING** Dropped support for Python 3.9. Minimum supported version is now Python 3.10.
17+
18+
## v1.7.0
19+
20+
**2026-02-16**
21+
22+
**Python SDK**
23+
24+
* **NEW** Support for [Project API Keys](basics.md#authentication) with automatic detection of organization and project from the key itself. The `organization_slug` / `project_slug` arguments to `taskbadger.init` are no longer required when using a project key.
25+
* **UPDATE** Legacy API keys (which require explicit `organization_slug` and `project_slug`) now emit a `DeprecationWarning`. Migrate to Project API keys.
26+
* **UPDATE** The CLI `configure` command now detects Project API keys and skips the organization/project prompts.
27+
828
## v1.6.3
929

1030
**2026-02-05**

docs/cli.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,29 @@ without the need to write any code.
99

1010
## Installation
1111

12-
The CLI is bundled with the Python client library. To install it you need:
12+
The CLI ships with the Python client library but its dependencies are an optional
13+
extra. To install it you need:
1314

14-
* Python > 3.7
15+
* Python 3.10
1516

1617
The recommended approach is to install the CLI as a tool using [uv](https://docs.astral.sh/uv/):
1718

1819
```shell
19-
$ uv tool install taskbadger
20+
$ uv tool install 'taskbadger[cli]'
2021
```
2122

2223
Alternatively you can install it into a virtual environment:
2324

2425
```shell
25-
$ uv pip install taskbadger
26+
$ uv pip install 'taskbadger[cli]'
2627
```
2728

29+
!!!note "Since v2.0.0"
30+
31+
The `cli` extra is required to run the `taskbadger` command. Installing
32+
`taskbadger` without it gives you the SDK only; running the CLI in that
33+
state will print an install hint rather than an `ImportError`.
34+
2835
## Monitoring processes
2936

3037
The main feature of the CLI is the `run` command which allows you to track tasks

0 commit comments

Comments
 (0)