Progress tracking (#17)

* Add progress bars and progress updates to protobuf messages

* Add progress tracking

* Add submitted at and started at to job dataclass

* Add GetJobProgress endpoint protobuf messages and rpc

* Prepare release v43

* Add unit test for progress recording

* Fix pytest.raises match regex ruff rule

* Exclude auto-generated code from pyright checks

* Fix job dataclass decoding

Author: lukasbindreiter

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ repos:
       - id: end-of-file-fixer
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     # keep the version here in sync with the version in uv.lock
-    rev: "v0.12.9"
+    rev: "v0.13.0"
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.43.0] - 2025-09-12
+
+- `tilebox-workflows`: Added progress tracking support to the `TaskRunner`.
+
 ## [0.42.0] - 2025-08-22
 
 ### Added
@@ -251,8 +255,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Released under the [MIT](https://opensource.org/license/mit) license.
 - Released packages: `tilebox-datasets`, `tilebox-workflows`, `tilebox-storage`, `tilebox-grpc`
 
-
-[Unreleased]: https://github.com/tilebox/tilebox-python/compare/v0.42.0...HEAD
+[Unreleased]: https://github.com/tilebox/tilebox-python/compare/v0.43.0...HEAD
+[0.43.0]: https://github.com/tilebox/tilebox-python/compare/v0.42.0...v0.43.0
 [0.42.0]: https://github.com/tilebox/tilebox-python/compare/v0.41.0...v0.42.0
 [0.41.0]: https://github.com/tilebox/tilebox-python/compare/v0.40.0...v0.41.0
 [0.40.0]: https://github.com/tilebox/tilebox-python/compare/v0.39.0...v0.40.0

README.md

@@ -36,11 +36,11 @@ Python library for [Tilebox](https://tilebox.com), a lightweight space data mana
 ## Install
 
 ```bash
-pip install tilebox-datasets tilebox-workflows tilebox-storage
+pip install tilebox
 ```
 
 > [!TIP]
-> For new projects we recommend using [uv](https://docs.astral.sh/uv/) - `uv add tilebox-datasets tilebox-workflows tilebox-storage`. Additional installation options are available [in our docs](https://docs.tilebox.com/sdks/python/install).
+> For new projects we recommend using [uv](https://docs.astral.sh/uv/) - `uv add tilebox`. Additional installation options are available [in our docs](https://docs.tilebox.com/sdks/python/install).
 
 ## Documentation
 
@@ -78,7 +78,6 @@ results = s2a_l1c.query(
 print(f"Found {results.sizes['time']} datapoints")  # Found 979 datapoints
 ```
 
-
 ### Tilebox Workflows
 
 A parallel processing engine to simplify the creation of dynamic tasks that can be executed across various computing environments, including on-premise and auto-scaling clusters in public clouds.

buf.gen.workflows.yaml

@@ -12,7 +12,7 @@ plugins:
     out: tilebox-workflows/tilebox/workflows
 inputs:
   # for local development
-  # - directory: ../api
+  # directory: ../api
   - module: buf.build/tilebox/api
     paths:
       - "workflows"

pyproject.toml

@@ -113,7 +113,13 @@ known-first-party = ["tilebox", "_tilebox"]
 "*/tests/*" = ["INP001", "SLF001"]
 
 [tool.pyright]
-exclude = ["**/.ipynb_checkpoints", "**/__pycache__", ".venv"]
+exclude = [
+    "**/.ipynb_checkpoints",
+    "**/__pycache__",
+    ".venv",
+    "tilebox-datasets/tests/example_dataset/*", # auto-generated code
+    "tilebox-workflows/tests/proto/*",          # auto-generated code
+]
 
 # ignore warnings in those files, but still type check them when used as a dependency in other files
 ignore = [

tilebox-datasets/tests/test_client.py

@@ -126,7 +126,7 @@ def test_datapoint_not_found() -> None:
     s2_dataset = client.dataset("open_data.copernicus.sentinel2_msi")
     collection = s2_dataset.collection("S2A_S2MSI1C")
 
-    with pytest.raises(NotFoundError, match="No such datapoint.*"):
+    with pytest.raises(NotFoundError, match=r"No such datapoint.*"):
         collection.find("0181f4ef-2040-101a-1423-d818e4d1895e")  # is in another collection
 
 

tilebox-datasets/tests/test_timeseries.py

@@ -186,15 +186,15 @@ def test_timeseries_dataset_collection_find_invalid_id() -> None:
         mocked.collection.find("invalid")
 
     mocked.service.query_by_id.side_effect = ArgumentError
-    with pytest.raises(ValueError, match="Invalid datapoint id.*"):
+    with pytest.raises(ValueError, match=r"Invalid datapoint id.*"):
         mocked.collection.find(uuid4())
 
 
 def test_timeseries_dataset_collection_find_not_found() -> None:
     """Test that .find() of a collection raises a NotFoundError if the datapoint is not found."""
     mocked = _mocked_collection()
     mocked.service.query_by_id.side_effect = NotFoundError
-    with pytest.raises(NotFoundError, match="No such datapoint.*"):
+    with pytest.raises(NotFoundError, match=r"No such datapoint.*"):
         mocked.collection.find("14eb91a2-a42f-421f-9397-1dab577f05a9")
 
 

tilebox-grpc/tests/aio/test_error.py

@@ -34,5 +34,5 @@ async def _mock_rpc() -> None:
             self.some_rpc = _mock_rpc
 
     stub = with_pythonic_errors(Stub())
-    with pytest.raises(exception_type, match=".*"):
+    with pytest.raises(exception_type, match=r".*"):
         await stub.some_rpc()

tilebox-grpc/tests/test_channel.py

@@ -88,10 +88,10 @@ def test_parse_channel_info_unix(url: str) -> None:
 
 
 def test_parse_channel_invalid() -> None:
-    with pytest.raises(ValueError, match="Invalid"):
+    with pytest.raises(ValueError, match=r"Invalid"):
         parse_channel_info("i'm not a url")
 
 
 def test_parse_channel_port_required_for_http() -> None:
-    with pytest.raises(ValueError, match="Explicit port required"):
+    with pytest.raises(ValueError, match=r"Explicit port required"):
         parse_channel_info("http://0.0.0.0")

tilebox-grpc/tests/test_error.py

@@ -38,5 +38,5 @@ def _mock_rpc() -> None:
             self.some_rpc = _mock_rpc
 
     stub = with_pythonic_errors(Stub())
-    with pytest.raises(exception_type, match=".*"):
+    with pytest.raises(exception_type, match=r".*"):
         stub.some_rpc()