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.6.tar.gz (91.3 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.6-py3-none-any.whl (68.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cf_setup-0.1.6.tar.gz
  • Upload date:
  • Size: 91.3 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.6.tar.gz
Algorithm Hash digest
SHA256 312686da5e3c693c345640d2a7daf5098419d37d93e4d18a20a3f75c747da92a
MD5 ff6dd2be4d101fd9036d506f6e74be96
BLAKE2b-256 485a9b275e2540d8739cf702a0238d3a001ac7f6c4434d2b68325af0d845c076

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cf_setup-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 68.6 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3117d1dca7fc344cbf32fa8b918d9ffc647f2362c08c87b00e660fdff2e4d28b
MD5 f8c75878ba563d042d6e9ab7e02a61f6
BLAKE2b-256 2d68b12c99918e92faac2c50a72c8cb131a35694d9bf476458fd3618cfc57c08

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