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-first 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 --profile full --editable cf-pipeline-engine

The repository entrypoint remains scripts/fresh_install_v2.ps1, but it now acts as a thin Windows wrapper that bootstraps Python and delegates orchestration into cf_setup.

cf_setup now supports two practical modes:

  • repository mode: used by scripts/fresh_install_v2.ps1 and local workspace maintainers
  • distribution mode: used when cf install runs without a repository checkout and must rely on packaged manifest resources plus published package artifacts

In distribution mode, cf install now also prepares the user workspace under ~/.cogniflow/workspace by default, initializes the semantics DuckDB 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-pipeline-engine example resources. It uses the distribution workspace rather than repository paths and is intentionally smaller than the full repo-maintainer 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 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.3.tar.gz (24.5 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.3-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cf_setup-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3a58235bbdc34ca5f17273a058ad76356c0de458a5c45de9e47169b9318e46b8
MD5 e76826ba85f931e7dc4105443c666a6d
BLAKE2b-256 74b62739f4a7394f301e66523245e4391c9e0aabd69c66725264170ab02047a8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cf_setup-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ad0bfe2bc078616371da0162fc4714205d06062025c0454f13cc98a512516960
MD5 c8402055d68c653d427e4f1faf43d802
BLAKE2b-256 14a0225691de3848ef4e5d5bf0baafb9a55b87114efceaaad41e2588fbce9162

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