Skip to main content

Cogniflow basic I/O StepPackage with thin declarative source/sink steps.

Project description

cf-basic-io

Cogniflow I/O StepPackage providing data source and sink steps.

Steps

Step Category Description
cfio:HandleSinkStep sink Persist data to DuckDB, CSV, or other handles
cfio:OpcuaReaderStep source Declare a one-shot OPC UA snapshot request for the pipeline runtime
cfio:JsonFieldSelectStep structural Extract one field from a JSON payload
cfio:TimestampToEpochStep structural Convert ISO-8601 timestamp to epoch seconds
cfio:EpochToTimestampStep structural Convert epoch seconds to ISO-8601 timestamp
cfio:ReportChartStep sink Render chart output for reporting
cfio:ReportTableStep sink Render table output for reporting
cfio:StatsRowStep structural Assemble structured row outputs

Dev/demo steps (cfbd:InlineSource, cfbd:OpcuaPhSource) now live in cf-basic-dev. Data hive parquet persistence now lives in cf-basic-sinks as cfsink:DataHiveParquetSinkStep.

Pipeline backend operations

The package also registers pipeline backend operations:

Operation Type Description
handle_sink python Persist via duckdb:// or csv:// handles
duckdb_checkpoint cpp Checkpoint pipeline state to DuckDB
duckdb_resume_from_checkpoint cpp Resume from checkpoint
duckdb_sql cpp Execute SQL on checkpoint data

Installation

pip install cf-basic-io

With optional dependencies:

pip install cf-basic-io[duckdb]   # DuckDB sink support
pip install cf-basic-io[all]      # All optional deps (currently duckdb)

Virtual OPC UA pH server

The demo OPC UA server lives in the separate cf-opcua-server package.

pip install cf-opcua-server
cf-opcua-server start --interval 0.5
# or:
python -m cf_opcua_server.cli start --interval 0.5
# server runs at opc.tcp://127.0.0.1:4840/VirtualPhServer with pH/temperature nodes under ns=2

cfbd:OpcuaPhSource (from cf-basic-dev) is a pure reader and does not start servers; run the demo server externally.

C++ Extensions

Native plugin surfaces for high-performance pipeline operations that stay owned by cf-basic-io:

  • _duckdb_backend_ops - DuckDB checkpoint/resume (requires DuckDB C++ library)

Build with C++ extensions:

CF_BASIC_IO_ENABLE_DUCKDB_CPP=1 pip install .

cfio:OpcuaReaderStep no longer links an OPC UA SDK inside cf-basic-io. The step stays declarative in this package and is executed by cf-pipeline-engine through the owner surface exported by cf-opcua-server.

Usage

from cf_basic_io.steps import handle_sink

# Write to DuckDB
handle_sink({"value": 42}, "duckdb:///output.duckdb?table=results")

StepPackage Integration

This package registers with Cogniflow via the cogniflow.steps entry point and ships steps.jsonld as its sole manifest. The cf:StepPackage node declares cf:packageId cf.basic.io.

Publishing

cf_basic_io is published with the dedicated Windows workflow:

  • Workflow: .github/workflows/cf_basic_io_windows_publish.yml
  • Package directory: sandcastle/cf_basic_steps/cf_basic_io
  • PyPI tag: cf-basic-io-v<version>
  • TestPyPI tag: cf-basic-io-v<version>-test

The publish path validates the default package build. OPC UA execution now lives behind the runtime-owned cf-opcua-server boundary, so no open62541 toggle is required for cf-basic-io publishing.

Local preflight:

powershell -ExecutionPolicy Bypass -File scripts/mimic_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_basic_io_windows_publish.yml `
  -PackageDir sandcastle/cf_basic_steps/cf_basic_io `
  -PythonExe py `
  -PythonVersion 3.13

Queue a dry-run dispatch:

powershell -ExecutionPolicy Bypass -File scripts/queue_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_basic_io_windows_publish.yml `
  -PackageDir sandcastle/cf_basic_steps/cf_basic_io `
  -PublishTarget testpypi `
  -Ref main `
  -RequireLocalPass `
  -DryRun

Watch queued runs:

gh run list --workflow cf_basic_io_windows_publish.yml --limit 10
gh run watch --exit-status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cf_basic_io-0.1.8.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cf_basic_io-0.1.8-cp313-cp313-win_amd64.whl (29.5 kB view details)

Uploaded CPython 3.13Windows x86-64

File details

Details for the file cf_basic_io-0.1.8.tar.gz.

File metadata

  • Download URL: cf_basic_io-0.1.8.tar.gz
  • Upload date:
  • Size: 43.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for cf_basic_io-0.1.8.tar.gz
Algorithm Hash digest
SHA256 142176d977c8337c3647becd62ce1032badf48d1c894cf94acb7c79654146f2c
MD5 117b6c64671f78fa740f638ed0eda4a7
BLAKE2b-256 95a3dd632bfc920ca1d3b2205fd69ac82a940a3baf7a02eb295ed28050dcc564

See more details on using hashes here.

File details

Details for the file cf_basic_io-0.1.8-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: cf_basic_io-0.1.8-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for cf_basic_io-0.1.8-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 e4977f50367fbf9224c5420d758464fc76ff534315c8be8f2e254ed975d3b610
MD5 bd72192e596c6a2b20f9d3fc638b697c
BLAKE2b-256 b06390392f8b5ad52e3e8d11ddbfa003f0c413846e29d2ae4ba345fd56d79bf5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page