Skip to main content

FLO reference implementation

Project description

FLO

FLO is a declarative language for modeling organizational 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


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\
  • DOT 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
  • Semantic SSOT: docs/design/IR.md
  • User-facing summary: README.md

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


Current Semantic Constraints (v0.1)

  • 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.

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.2.tar.gz (72.0 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.2-py3-none-any.whl (93.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flo_lang-0.1.2.tar.gz
  • Upload date:
  • Size: 72.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for flo_lang-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f9c16f4b28bcc4b47b240429c12ebffd2166a6fa31a431f50b8a6c8d9e68fc55
MD5 3c3dd63363d9d645b858fd375963f5dc
BLAKE2b-256 bb4646ff76e688eb58a326bba62cc1596e7c85942d1abc91342f34d0fd389999

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flo_lang-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 93.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for flo_lang-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1d525a4088807c0021d1f60361936c3deda9f2bdfb4270aae19daf378101b571
MD5 a84ab050ba35f3b3008139ab6c9aedcd
BLAKE2b-256 7a48d3746cff13a392e8bd43e9b6d5fa86333df2fe8ecceb4b9330e017ff55e6

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