Metadata-Version: 2.4
Name: cf-pipeline-report
Version: 0.0.1
Summary: HTML pipeline report renderer for Cogniflow
Author-email: Cogniflow <gerrit.renner@uni-due.de>
Project-URL: Homepage, https://github.com/cogniflow/cogniflow-playground
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: rdflib==7.4.0
Requires-Dist: duckdb==1.4.2
Requires-Dist: fastapi==0.115.5
Requires-Dist: uvicorn==0.30.6
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"

# cf-pipeline-report

Minimal HTML report renderer for Cogniflow pipeline manifests.

Published distribution name:

```bash
pip install cf-pipeline-report
```

Status: early scaffolding. The renderer outputs a static HTML shell that uses
Observable Runtime (observablehq) to fetch a JSON payload and render a live
pipeline view. The payload can be served by a small API so the report stays
decoupled from the running pipeline.

Quick start (static JSON payload):
```
cf pipeline report-render sandcastle/cf_pipeline/cf_pipeline_engine/examples/opcua_fifo_avg_to_duckdb_parquet_triggered.jsonld
python -m http.server --directory sandcastle/cf_pipeline/cf_pipeline_engine/examples 8000
```

Live API (DuckDB-backed):
```
cf pipeline report sandcastle/cf_pipeline/cf_pipeline_engine/examples/opcua_fifo_avg_to_duckdb_parquet_triggered.jsonld --duckdb path/to/pipeline.duckdb
```
Then open http://127.0.0.1:8765/ in the browser.

Multiple pipelines (directory of manifests):
```
cf pipeline report sandcastle/cf_pipeline/cf_pipeline_engine/examples --duckdb-dir path/to/duckdb
```
The server will expose one report per pipeline and look for files named
`<pipeline_id>.duckdb` in the provided directory (or nested under
`<pipeline_id>/<pipeline_id>.duckdb`).

Live tables/plots read from the DuckDB view `pipeline_data` created by the
Parquet archive sink. Ensure the pipeline writes to DuckDB before opening
the report, or the live sections will show empty data.

If no `--duckdb`/`--duckdb-dir` is provided, the server will try to resolve the
DuckDB file from the manifest by reading `pipelineId` and `baseDir` parameters
on the `ParquetArchiveSinkStep`. In this repo the recommended default is
`sandcastle/data_hive/<pipelineId>/<pipelineId>.duckdb`.

## Publishing

`cf_pipeline_report` is published with the dedicated Windows workflow:

- Workflow: `.github/workflows/cf_pipeline_report_windows_publish.yml`
- Package directory: `sandcastle/cf_pipeline/cf_pipeline_report`
- PyPI tag: `cf-pipeline-report-v<version>`
- TestPyPI tag: `cf-pipeline-report-v<version>-test`

Local preflight:

```powershell
powershell -ExecutionPolicy Bypass -File scripts/mimic_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_pipeline_report_windows_publish.yml `
  -PackageDir sandcastle/cf_pipeline/cf_pipeline_report `
  -PythonExe py `
  -PythonVersion 3.13
```

Queue a dry-run dispatch:

```powershell
powershell -ExecutionPolicy Bypass -File scripts/queue_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_pipeline_report_windows_publish.yml `
  -PackageDir sandcastle/cf_pipeline/cf_pipeline_report `
  -PublishTarget testpypi `
  -Ref main `
  -RequireLocalPass `
  -DryRun
```
