Skip to main content

Manifest-driven Cogniflow workspace setup orchestration

Project description

cf-setup

cf-setup is the first-party setup orchestrator for the Cogniflow Windows workspace.

It centralizes:

  • module and profile definitions
  • deterministic install planning
  • PyPI vs local-build vs editable source decisions
  • Windows prerequisite diagnostics
  • delegated native or frontend build steps
  • post-install hooks
  • structured installation reporting

Typical usage:

py -3.14 -m cf_setup plan --profile core --format json
py -3.14 -m cf_setup diagnose --provider windows --format json
py -3.14 -m cf_setup install --dev --profile full --editable cf-pipeline-engine
py -3.14 -m cf_setup incremental --module cf-basic-io --smoke

The dedicated bootstrap entrypoint is cf-setup-bootstrap ...; it bootstraps Python and delegates orchestration into cf_setup.

cf_setup now supports two practical modes:

  • repository mode: used by the local cf_setup bootstrap and workspace maintainers
  • distribution mode: used when cf install runs without a repository checkout and must rely on packaged manifest resources plus published package artifacts

For repository users, the recommended public-facing workflow is now pip install cogniflow followed by cf install --dev. Internally, --dev is a CLI alias for repository mode.

In distribution mode, cf install now also prepares the user workspace under ~/.cogniflow/workspace by default, initializes the semantics store files, and runs installed-step ingestion so the environment is usable immediately after setup.

cf install --run-demo in distribution mode now runs a small published demo from packaged cf-setup demo resources. The demo uses the same semantics-runtime discovery and ingestion framework that loads packaged ontology N-Quads and installed step packages into the workspace store, rather than a separate legacy demo path.

Incremental Development

The cf_setup bootstrap remains the hard full-reset bootstrap and demo gate when you need a repo-local entrypoint.

For faster local iteration, cf_setup incremental updates only the requested first-party module scope plus its compile and tooling prerequisites:

py -3.14 -m cf_setup incremental --module cf-basic-io --smoke
py -3.14 -m cf_setup incremental --module cf-package-contracts --run-demo

Key behavior:

  • no factory reset
  • no global uninstall of all managed packages
  • same native toolchain environment as the full installer
  • pip check still runs
  • installed-step ingestion still runs when step packages are in scope
  • --run-demo remains optional and reuses the maintained semantics-runtime demo path

Publishing

cf-setup is prepared for the dedicated Windows workflow:

  • Workflow: .github/workflows/cf_setup_windows_publish.yml
  • Package directory: sandcastle/cf_setup
  • PyPI tag: cf-setup-v<version>
  • TestPyPI tag: cf-setup-v<version>-test
  • Release order: publish cf-core-cli 0.1.5 first, then cf-setup, then cf-setup-wizard, then cogniflow

Local preflight:

powershell -ExecutionPolicy Bypass -File scripts/mimic_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_setup_windows_publish.yml `
  -PackageDir sandcastle/cf_setup `
  -PythonExe py `
  -PythonVersion 3.14

Queue a dry-run dispatch:

powershell -ExecutionPolicy Bypass -File scripts/queue_windows_python_publish_workflow.ps1 `
  -WorkflowFile .github/workflows/cf_setup_windows_publish.yml `
  -PackageDir sandcastle/cf_setup `
  -PublishTarget testpypi `
  -Ref main `
  -RequireLocalPass `
  -DryRun `
  -ReleaseTag cf-setup-v0.1.3-test

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_setup-0.1.5.tar.gz (99.0 kB view details)

Uploaded Source

Built Distribution

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

cf_setup-0.1.5-py3-none-any.whl (71.7 kB view details)

Uploaded Python 3

File details

Details for the file cf_setup-0.1.5.tar.gz.

File metadata

  • Download URL: cf_setup-0.1.5.tar.gz
  • Upload date:
  • Size: 99.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for cf_setup-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ba9a78148853a3665f4624dc519b873dac86b0d80d1d46331365b1cfe8e19770
MD5 c6aced515fee4043e20f0a5b70c3204a
BLAKE2b-256 d0168476096f6706e4e73d6ed0b0296605f1e0a156f157e0de1a1ca18b33c349

See more details on using hashes here.

File details

Details for the file cf_setup-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: cf_setup-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 71.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for cf_setup-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c521799a9b36a9f4b0b3338a09666a52c143f022db7a1116432436f81bcfa6cb
MD5 5d4d415141c09d64e7d509070c4a0a97
BLAKE2b-256 dfb147056dd7f3479f787fcdda46387a00604153e19991946412b75a3bb09c8b

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