Skip to main content

FLO reference implementation

Project description

FLO

FLO is a declarative language for modeling process flow.

It allows you to define processes in a minimal, versioned format and compile them into a canonical graph representation (FLO IR) for visualization and analysis.

User documentation: docs/User_Manual.md


Development Workflow (uv)

FLO uses uv as the canonical developer tool for environment management, dependency sync, running commands, builds, and publish.

From the repository root:

uv sync --dev

Run FLO locally:

uv run flo render examples/reference/linear.flo

Run quality gates:

uv run pre-commit run --all-files

Build distributions:

uv build

Publish (token auth):

uv publish dist/flo_lang-<version>*
# username prompt: __token__
# password prompt: pypi-<token>

Example

spec_version: "0.1"

process:
  id: onboarding_v1
  name: Client Onboarding
  version: 1
  owner:
    id: ops_mgr
    name: Ops Manager
  business_units:
    - id: sales
      name: Sales
    - id: ops
      name: Operations

steps:
  - id: start
    kind: start
    name: Start

  - id: collect_docs
    kind: task
    name: Collect Documents
    lane: sales

  - id: verify
    kind: task
    name: Verify Documents
    lane: ops

  - id: approved
    kind: decision
    name: Approved?
    outcomes:
      yes: finish
      no: collect_docs

  - id: finish
    kind: end
    name: Complete

What FLO Provides

  • Deterministic compilation to FLO IR\
  • Structural and semantic validation\
  • Graph projections: flowchart, swimlane, spaghetti map, SPPM\
  • SVG and JSON exports\
  • Ingredients list and movement report exports\
  • Stable foundation for analytics

What FLO Does Not Provide

  • Workflow execution\
  • Task scheduling\
  • Orchestration\
  • Simulation engines (v0.x)

Architecture

  • src/flo/ --- compiler, validators, renderers, and CLI\
  • schema/ --- JSON schemas for FLO IR and types\
  • examples/ --- canonical reference examples\
  • tests/ --- unit, integration, and conformance tests\
  • docs/ --- user manual and design documents

Downstream projects depend on FLO IR.


Source of Truth Hierarchy

  • Structural contract SSOT: schema/flo_ir.json
  • Policy authority: docs/policy/authoritative_artifacts.md
  • Diagram and artifact specs: docs/specs/
  • Core semantic spec: docs/specs/core_language.md
  • Historical semantic background note: docs/design/history/IR.md
  • User-facing summary: README.md

Hierarchy policy and update workflow are defined in docs/policy/authoritative_artifacts.md.


Current Semantic Constraints (v0.1)

This is a summary only. Normative semantics live in docs/specs/core_language.md.

  • Exactly one start node.
  • At least one end node.
  • All edge endpoints must resolve to declared node IDs.
  • Every non-start node must have at least one predecessor.
  • Every non-end node must have at least one successor.
  • Every node must be reachable from start.
  • Every node must be able to reach at least one end node.
  • decision nodes must have at least two outgoing transitions.
  • wait_time is valid only on queue nodes.

Versioning

FLO follows semantic versioning at the spec level.

  • v0.x: rapid iteration\
  • v1.0: language stability

Philosophy

FLO treats processes as first-class artifacts:

  • Explicit\
  • Versioned\
  • Portable\
  • Validatable

It is a small language by design.


Schema Contract & Migration

As of v0.1 the compiler emits a schema-shaped canonical IR and the runtime enforces that contract. The compiler must set IR.schema_aligned to True and IR.to_dict() will produce the top-level mapping with process, nodes, and edges fields required by the authoritative JSON Schema in schema/flo_ir.json.

If you are upgrading from an earlier development version that relied on an internal IR translator, update any custom compiler integrations to emit the schema-shaped IR directly. The translator was intentionally removed; CI now validates example outputs using the same schema and will fail when the contract is violated.

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

flo_lang-0.1.4.tar.gz (131.1 kB view details)

Uploaded Source

Built Distribution

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

flo_lang-0.1.4-py3-none-any.whl (171.5 kB view details)

Uploaded Python 3

File details

Details for the file flo_lang-0.1.4.tar.gz.

File metadata

  • Download URL: flo_lang-0.1.4.tar.gz
  • Upload date:
  • Size: 131.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flo_lang-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6634c24752ff1f2410bfb3ee713b50b1e15bea3542e18eb3e8bbafa9eed820c9
MD5 9116a71bbc7c08a9a87970eefcb3c219
BLAKE2b-256 fa93ef284124f250f3038fe7c535ca2e3f2a2261f973415946c414a472416ea4

See more details on using hashes here.

Provenance

The following attestation bundles were made for flo_lang-0.1.4.tar.gz:

Publisher: publish.yml on shanewilkins/FLO

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flo_lang-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: flo_lang-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 171.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flo_lang-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8fd54124a713c08024b055ec5e384374899c8a31ca6460572d10633447780ff7
MD5 bbf6f0487c4013c1d0d4fa57b70cdba7
BLAKE2b-256 037dc3c9534e87c21e4c3c83146c0150781217e36897e4bb0c36b5150bcd40a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for flo_lang-0.1.4-py3-none-any.whl:

Publisher: publish.yml on shanewilkins/FLO

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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