taskflow-meter 1.0.0__tar.gz

taskflow_meter-1.0.0/.gitignore

@@ -0,0 +1,26 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Generated by hatch-vcs at build time
+taskflow_meter/_version.py
+
+# Tooling caches and reports
+.tox/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Resolved by uv on demand; this is a library, so the lock is not pinned
+uv.lock

taskflow_meter-1.0.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+

taskflow_meter-1.0.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.5
+Name: taskflow-meter
+Version: 1.0.0
+Summary: Monitoring interfaces (ASGI, WSGI, datasource) for OpenStack TaskFlow flow execution progress
+Project-URL: Homepage, https://github.com/daipham3213/taskflow-meter
+Project-URL: Source, https://github.com/daipham3213/taskflow-meter
+Project-URL: Issues, https://github.com/daipham3213/taskflow-meter/issues
+Project-URL: Changelog, https://github.com/daipham3213/taskflow-meter/releases
+Author-email: Pham Le Gia Dai <daipham.3213@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: asgi,monitoring,openstack,taskflow,workflow,wsgi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Monitoring
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: oslo-cache>=3.0.0
+Requires-Dist: oslo-config>=9.0.0
+Requires-Dist: oslo-serialization>=2.18.0
+Requires-Dist: oslo-utils>=3.33.0
+Requires-Dist: stevedore>=1.20.0
+Requires-Dist: taskflow>=6.4.0
+Provides-Extra: all
+Requires-Dist: alembic>=1.13; extra == 'all'
+Requires-Dist: kombu>=5.0; extra == 'all'
+Requires-Dist: oslo-cache[dogpile]>=3.0.0; extra == 'all'
+Requires-Dist: oslo-cache[etcd3gw]>=3.0.0; extra == 'all'
+Requires-Dist: prometheus-client>=0.20; extra == 'all'
+Requires-Dist: sqlalchemy>=2.0; extra == 'all'
+Provides-Extra: amqp
+Requires-Dist: kombu>=5.0; extra == 'amqp'
+Provides-Extra: etcd
+Requires-Dist: oslo-cache[etcd3gw]>=3.0.0; extra == 'etcd'
+Provides-Extra: memcache
+Requires-Dist: oslo-cache[dogpile]>=3.0.0; extra == 'memcache'
+Provides-Extra: prometheus
+Requires-Dist: prometheus-client>=0.20; extra == 'prometheus'
+Provides-Extra: sqlalchemy
+Requires-Dist: alembic>=1.13; extra == 'sqlalchemy'
+Requires-Dist: sqlalchemy>=2.0; extra == 'sqlalchemy'
+Description-Content-Type: text/markdown
+
+# taskflow-meter
+
+Monitoring interfaces — ASGI, WSGI, datasources, transports — for observing
+[OpenStack TaskFlow](https://opendev.org/openstack/taskflow) flow execution
+progress.
+
+> **Status: pre-alpha.** The packaging, tooling and CI skeleton are in place
+> (milestone M0). The design is specified in [`docs/PLAN.md`](docs/PLAN.md);
+> functionality lands milestone by milestone against it.
+
+## What it is for
+
+TaskFlow knows exactly where a flow is — which atoms have run, which are
+running, how far along each task reports itself — but it offers no way to
+*look* at that from outside the process running the flow. `taskflow-meter`
+provides that view:
+
+- **Read-only over your existing persistence backend.** Task progress is
+  written through to the persistence layer on every `update_progress()` call,
+  so an existing deployment can be monitored with *no changes to flow code*.
+- **Embeddable anywhere.** Ships a hand-rolled ASGI callable and a hand-rolled
+  WSGI callable with no web framework dependency, mountable at any sub-path
+  inside FastAPI, Starlette, Flask, Django, or served standalone.
+- **Live, in-process option.** Attach a listener plus a per-atom progress tap
+  to an engine for sub-second latency and full DAG topology.
+
+## Using it
+
+Point a meter at a taskflow persistence backend and serve it:
+
+```python
+from taskflow_meter.api.asgi import ASGIApp
+from taskflow_meter.datasource.persistence import PersistenceDataSource
+from taskflow_meter.meter import Meter
+
+source = PersistenceDataSource(conf={"connection": "sqlite:///taskflow.db"})
+meter = Meter(source)  # polls the backend, keeps an event stream
+app = ASGIApp(meter)  # a plain ASGI 3 callable
+```
+
+`app` runs under any ASGI server (`uvicorn module:app`), or mounts inside an
+application you already have:
+
+```python
+host.mount("/taskflow", ASGIApp(meter))  # Starlette / FastAPI
+```
+
+There is a WSGI callable too, with identical behaviour -- a conformance suite
+compares the two byte for byte:
+
+```python
+from taskflow_meter.api.wsgi import WSGIApp
+
+application = WSGIApp(meter)  # gunicorn module:application
+
+app.wsgi_app = DispatcherMiddleware(  # Flask / werkzeug
+    app.wsgi_app, {"/taskflow": WSGIApp(meter)}
+)
+```
+
+Or serve it straight away, with no server dependency at all:
+
+```bash
+taskflow-meter serve --connection sqlite:///taskflow.db
+```
+
+That runs on `wsgiref` from the standard library and binds localhost. It is a
+development server -- put the WSGI callable behind gunicorn for anything real.
+
+For a fleet, run the collector: the flows publish to a broker, one process
+writes to the meter's own database, and the API workers read it without
+polling anything.
+
+```bash
+taskflow-meter upgrade --store-url postgresql://host/meter
+taskflow-meter collect --amqp-url amqp://broker// --store-url postgresql://host/meter
+taskflow-meter serve   --store-url postgresql://host/meter
+```
+One caveat for WSGI deployments: a synchronous worker holds a thread for as
+long as an SSE stream stays open, so use gevent or eventlet workers for
+streaming, or let clients poll `/events?since_seq=` instead.
+
+Mounted apps never receive the ASGI lifespan scope, so the meter also starts
+itself on the first request. If your host application has a lifespan of its
+own, prefer `meter.start()` / `meter.stop()` from it.
+
+### Inside a service you already run
+
+If your service composes its WSGI stack from `api-paste.ini`, dispatch a
+prefix to the meter and configure it in the service's own config file:
+
+```ini
+[composite:main]
+use = egg:Paste#urlmap
+/: your_api
+/taskflow-meter: taskflow_meter
+
+[app:taskflow_meter]
+paste.app_factory = taskflow_meter.contrib.paste:app_factory
+```
+
+```ini
+[taskflow_meter]
+connection = mysql+pymysql://user:password@host/taskflow
+```
+
+Native adapters exist for the frameworks where the routes should live inside
+the host application rather than beside it, so its auth and middleware apply
+to them:
+
+| Host | Adapter |
+| --- | --- |
+| FastAPI | `contrib.fastapi.meter_router(meter)` |
+| Flask | `contrib.flask.meter_blueprint(meter)` |
+| Django | `contrib.django.meter_urlpatterns(meter)` |
+| Pecan | `contrib.pecan.MeterController()` |
+| paste | `contrib.paste:app_factory` |
+
+See [the guide](docs/guide.md) for all of them, and for how to read completion
+and current-task out of the API.
+
+### Watching from inside the process running the flow
+
+If you control the code that runs the flow, attaching to the engine gets you
+what reading persistence cannot: progress readable in single-digit
+milliseconds instead of a poll interval, and the flow's graph, which taskflow
+never persists.
+
+```python
+from taskflow_meter.collect import attach
+
+with attach(engine) as watched:
+    engine.run()
+    meter = Meter(watched.store, poll=False)
+```
+
+Delivery happens on its own thread behind a bounded queue, so a task never
+waits on a publisher, and no failure downstream -- a broken webhook, a full
+queue, a publisher that raises -- can fail a task.
+
+### Endpoints
+
+| Path | What it returns |
+| --- | --- |
+| `GET /healthz` | Liveness, version, and poller counters |
+| `GET /api/v1/flows` | Flows, newest first, filterable and paged |
+| `GET /api/v1/flows/{run_id}` | One flow with its atoms |
+| `GET /api/v1/flows/{run_id}/atoms` | Just the atoms |
+| `GET /api/v1/flows/{run_id}/events` | Event history from `?since_seq=` |
+| `GET /api/v1/flows/{run_id}/stream` | The same events as SSE, live |
+
+The stream honours `Last-Event-ID`, so a dropped connection resumes where it
+left off rather than leaving a hole. If the datasource keeps no history, the
+two event endpoints answer 501 and flow payloads omit their links, rather than
+serving an empty stream that cannot be told apart from silence.
+
+## Requirements
+
+- Python 3.11+
+- taskflow 6.4.0+
+
+## Examples
+
+Runnable, and covered by the test suite so they cannot rot:
+[`examples/`](examples/).
+
+## Development
+
+This project builds with [Hatch](https://hatch.pypa.io) (`hatchling` +
+`hatch-vcs`, so the version comes from git tags) and is developed with
+[uv](https://docs.astral.sh/uv/).
+
+```bash
+uv run --group dev pytest          # tests
+uv run --group dev ruff check .    # lint
+uv run --group dev ruff format .   # format
+uv run --group dev mypy            # type check
+uv build                           # build sdist + wheel
+```
+
+`tox` is available too, and is what CI reproduces:
+
+```bash
+uvx tox -e pep8          # ruff, hacking, mypy, and the test-tree check
+uvx tox -e py312         # tests on one interpreter
+uvx tox                  # the whole matrix
+```
+
+Because the version is derived from git history, a shallow clone or a checkout
+with no tags will build as `0.0.0`. CI checks out with full history.
+
+### Where tests go
+
+A unit test module mirrors the module it targets, so finding the tests for a
+file is mechanical rather than a search:
+
+| Module | Its tests |
+| --- | --- |
+| `taskflow_meter/diff.py` | `tests/unit/test_diff.py` |
+| `taskflow_meter/datasource/memory.py` | `tests/unit/datasource/test_memory.py` |
+
+Tests that do not target a single module go in a sibling tree instead --
+`tests/functional/`, `tests/integration/` or `tests/conformance/`. Anything
+misplaced fails `tox -e pep8`.
+
+## License
+
+Apache-2.0. See [`LICENSE`](LICENSE).

taskflow_meter-1.0.0/README.md

@@ -0,0 +1,208 @@
+# taskflow-meter
+
+Monitoring interfaces — ASGI, WSGI, datasources, transports — for observing
+[OpenStack TaskFlow](https://opendev.org/openstack/taskflow) flow execution
+progress.
+
+> **Status: pre-alpha.** The packaging, tooling and CI skeleton are in place
+> (milestone M0). The design is specified in [`docs/PLAN.md`](docs/PLAN.md);
+> functionality lands milestone by milestone against it.
+
+## What it is for
+
+TaskFlow knows exactly where a flow is — which atoms have run, which are
+running, how far along each task reports itself — but it offers no way to
+*look* at that from outside the process running the flow. `taskflow-meter`
+provides that view:
+
+- **Read-only over your existing persistence backend.** Task progress is
+  written through to the persistence layer on every `update_progress()` call,
+  so an existing deployment can be monitored with *no changes to flow code*.
+- **Embeddable anywhere.** Ships a hand-rolled ASGI callable and a hand-rolled
+  WSGI callable with no web framework dependency, mountable at any sub-path
+  inside FastAPI, Starlette, Flask, Django, or served standalone.
+- **Live, in-process option.** Attach a listener plus a per-atom progress tap
+  to an engine for sub-second latency and full DAG topology.
+
+## Using it
+
+Point a meter at a taskflow persistence backend and serve it:
+
+```python
+from taskflow_meter.api.asgi import ASGIApp
+from taskflow_meter.datasource.persistence import PersistenceDataSource
+from taskflow_meter.meter import Meter
+
+source = PersistenceDataSource(conf={"connection": "sqlite:///taskflow.db"})
+meter = Meter(source)  # polls the backend, keeps an event stream
+app = ASGIApp(meter)  # a plain ASGI 3 callable
+```
+
+`app` runs under any ASGI server (`uvicorn module:app`), or mounts inside an
+application you already have:
+
+```python
+host.mount("/taskflow", ASGIApp(meter))  # Starlette / FastAPI
+```
+
+There is a WSGI callable too, with identical behaviour -- a conformance suite
+compares the two byte for byte:
+
+```python
+from taskflow_meter.api.wsgi import WSGIApp
+
+application = WSGIApp(meter)  # gunicorn module:application
+
+app.wsgi_app = DispatcherMiddleware(  # Flask / werkzeug
+    app.wsgi_app, {"/taskflow": WSGIApp(meter)}
+)
+```
+
+Or serve it straight away, with no server dependency at all:
+
+```bash
+taskflow-meter serve --connection sqlite:///taskflow.db
+```
+
+That runs on `wsgiref` from the standard library and binds localhost. It is a
+development server -- put the WSGI callable behind gunicorn for anything real.
+
+For a fleet, run the collector: the flows publish to a broker, one process
+writes to the meter's own database, and the API workers read it without
+polling anything.
+
+```bash
+taskflow-meter upgrade --store-url postgresql://host/meter
+taskflow-meter collect --amqp-url amqp://broker// --store-url postgresql://host/meter
+taskflow-meter serve   --store-url postgresql://host/meter
+```
+One caveat for WSGI deployments: a synchronous worker holds a thread for as
+long as an SSE stream stays open, so use gevent or eventlet workers for
+streaming, or let clients poll `/events?since_seq=` instead.
+
+Mounted apps never receive the ASGI lifespan scope, so the meter also starts
+itself on the first request. If your host application has a lifespan of its
+own, prefer `meter.start()` / `meter.stop()` from it.
+
+### Inside a service you already run
+
+If your service composes its WSGI stack from `api-paste.ini`, dispatch a
+prefix to the meter and configure it in the service's own config file:
+
+```ini
+[composite:main]
+use = egg:Paste#urlmap
+/: your_api
+/taskflow-meter: taskflow_meter
+
+[app:taskflow_meter]
+paste.app_factory = taskflow_meter.contrib.paste:app_factory
+```
+
+```ini
+[taskflow_meter]
+connection = mysql+pymysql://user:password@host/taskflow
+```
+
+Native adapters exist for the frameworks where the routes should live inside
+the host application rather than beside it, so its auth and middleware apply
+to them:
+
+| Host | Adapter |
+| --- | --- |
+| FastAPI | `contrib.fastapi.meter_router(meter)` |
+| Flask | `contrib.flask.meter_blueprint(meter)` |
+| Django | `contrib.django.meter_urlpatterns(meter)` |
+| Pecan | `contrib.pecan.MeterController()` |
+| paste | `contrib.paste:app_factory` |
+
+See [the guide](docs/guide.md) for all of them, and for how to read completion
+and current-task out of the API.
+
+### Watching from inside the process running the flow
+
+If you control the code that runs the flow, attaching to the engine gets you
+what reading persistence cannot: progress readable in single-digit
+milliseconds instead of a poll interval, and the flow's graph, which taskflow
+never persists.
+
+```python
+from taskflow_meter.collect import attach
+
+with attach(engine) as watched:
+    engine.run()
+    meter = Meter(watched.store, poll=False)
+```
+
+Delivery happens on its own thread behind a bounded queue, so a task never
+waits on a publisher, and no failure downstream -- a broken webhook, a full
+queue, a publisher that raises -- can fail a task.
+
+### Endpoints
+
+| Path | What it returns |
+| --- | --- |
+| `GET /healthz` | Liveness, version, and poller counters |
+| `GET /api/v1/flows` | Flows, newest first, filterable and paged |
+| `GET /api/v1/flows/{run_id}` | One flow with its atoms |
+| `GET /api/v1/flows/{run_id}/atoms` | Just the atoms |
+| `GET /api/v1/flows/{run_id}/events` | Event history from `?since_seq=` |
+| `GET /api/v1/flows/{run_id}/stream` | The same events as SSE, live |
+
+The stream honours `Last-Event-ID`, so a dropped connection resumes where it
+left off rather than leaving a hole. If the datasource keeps no history, the
+two event endpoints answer 501 and flow payloads omit their links, rather than
+serving an empty stream that cannot be told apart from silence.
+
+## Requirements
+
+- Python 3.11+
+- taskflow 6.4.0+
+
+## Examples
+
+Runnable, and covered by the test suite so they cannot rot:
+[`examples/`](examples/).
+
+## Development
+
+This project builds with [Hatch](https://hatch.pypa.io) (`hatchling` +
+`hatch-vcs`, so the version comes from git tags) and is developed with
+[uv](https://docs.astral.sh/uv/).
+
+```bash
+uv run --group dev pytest          # tests
+uv run --group dev ruff check .    # lint
+uv run --group dev ruff format .   # format
+uv run --group dev mypy            # type check
+uv build                           # build sdist + wheel
+```
+
+`tox` is available too, and is what CI reproduces:
+
+```bash
+uvx tox -e pep8          # ruff, hacking, mypy, and the test-tree check
+uvx tox -e py312         # tests on one interpreter
+uvx tox                  # the whole matrix
+```
+
+Because the version is derived from git history, a shallow clone or a checkout
+with no tags will build as `0.0.0`. CI checks out with full history.
+
+### Where tests go
+
+A unit test module mirrors the module it targets, so finding the tests for a
+file is mechanical rather than a search:
+
+| Module | Its tests |
+| --- | --- |
+| `taskflow_meter/diff.py` | `tests/unit/test_diff.py` |
+| `taskflow_meter/datasource/memory.py` | `tests/unit/datasource/test_memory.py` |
+
+Tests that do not target a single module go in a sibling tree instead --
+`tests/functional/`, `tests/integration/` or `tests/conformance/`. Anything
+misplaced fails `tox -e pep8`.
+
+## License
+
+Apache-2.0. See [`LICENSE`](LICENSE).