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.nq 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.2.1.tar.gz (45.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.2.1-cp313-cp313-win_amd64.whl (31.0 kB view details)

Uploaded CPython 3.13Windows x86-64

File details

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

File metadata

  • Download URL: cf_basic_io-0.2.1.tar.gz
  • Upload date:
  • Size: 45.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.2.1.tar.gz
Algorithm Hash digest
SHA256 fba831ab7585988eb3b1c9253d63b0ac0bbb93f7d53145366cfbcf10b1259ff3
MD5 87777f9128ed5f1442866ee9edb5c14e
BLAKE2b-256 4b98dcf78fc6a72b6eeae52eb646a0ec3a24c1482e4fb3c63411ab462d1ab280

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cf_basic_io-0.2.1-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 31.0 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.2.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 b430d112e53b5d1fdc2ca7a4a7ea07bdb95f7772efc6d14c038c251bd09dec50
MD5 49b1979c7a2555fa6ece3d62d99aa254
BLAKE2b-256 003281a6f6c1aaac21219c81f0896219b848c0a0c3e24b8df23749e84b2bf6d4

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