This release is a pre-release and may not be stable for production use.
Lintel
Lintel turns a UMF document plus an exposure file into a prepared GraphQL API and serves it with FastAPI.
Status: alpha. It works end to end against an in-memory data port. It has no
database-backed port yet, so it is not integrated with Truss, UMF Access or PostgreSQL.
The PyPI project is lintel-api (the unrelated lintel project is a docstring checker).
Quickstart
Python 3.11 or newer. This block is executed by CI from a freshly built wheel.
pip install --pre "lintel-api[build,serve]"
lintel example task-board demo
lintel prepare demo/task-board.umf.json --exposure demo/exposure.json --host demo/host-profile.json -o demo/api.json
# The server prints its x-lintel-api digest; use it as $DIGEST in a second terminal.
lintel serve demo/api.json --records demo/records.json &
curl -s localhost:8000/graphql -H "x-lintel-api: $DIGEST" -H 'content-type: application/json' -d '{"query":"{ node(id: \"demo.task-board.identity-v1:board.Task:task-1\") { id ... on Task { title estimate } } }"}'
The answer is {"data":{"node":{"id":"demo.task-board.identity-v1:board.Task:task-1","title":"Write the quickstart","estimate":"3.50"}}}.
lintel example writes four files: the UMF model, an exposure file (which records and
fields the API shows), a host profile (limits) and records.json (the demo rows).
lintel prepare validates the UMF document and issues api.json, a pinned artifact.
lintel serve admits the artifact and serves POST /graphql on 127.0.0.1:8000.
Every request must send the artifact's digest in x-lintel-api. serve applies no
authentication; keep it on localhost.
What is tested
CI (Linux, Python 3.11) tests: preparing v1 prepared APIs from UMF (umf-core 0.10.x),
keyed node / nodes reads through the in-memory port, runtime admission and tamper
checks, Node IDs, and the commands above from a built wheel in a fresh virtualenv.
Not provided: a Truss/UMF Access/PostgreSQL port, mutations, Relay connections served by
lintel serve, TypeScript clients, Batten embedding. Prepared-API v2 to v4 artifacts can be
loaded by the runtime, but their builders need umf_access_generated_executor, which is not
published, so they raise UNSUPPORTED without it.
Stack integration
Lintel imports only umf-core (the build extra; UMF validation and reading). It does not
import umf-weft, umf-codegen, umf-access, Truss or Ashlar. The runtime itself imports
no UMF package.
Embedding
Mount the router in your own FastAPI app with your own authenticated scope and port:
from lintel.graphql import create_router
from lintel.projection import load_prepared_api
router = create_router(prepared, my_execution_port, my_node_codec, resolve_scope)
my_execution_port implements lintel.ports.ExecutionPort; lintel.memory.MemoryPort is a
reference implementation. See architecture and the
contracts.
Prepared API v5 HTTP contracts
lintel.build.http_projection.project_http(prepared) returns an OpenAPI 3.1
document and named operation definitions from an admitted prepared API v5.
It covers JSON:API resource refetch and forward pages and separate invocation
and observation descriptions for declared commands. The projection rejects
prepared artifacts with selected relationships. These build outputs describe
interfaces for client generation. The served API uses GraphQL.
Experimental
lintel.experimental (install lintel-api[experimental]) is a laboratory projection with
probe and echo roots. It is not a production API and may change or disappear.
Development
uv sync --locked
uv run ruff check . && uv run pyright && uv run pytest -q
Metadata
Release files for lintel-api 0.1.0a6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| lintel_api-0.1.0a6.tar.gz | 201.1 kB | With provenance | Details for lintel_api-0.1.0a6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| lintel_api-0.1.0a6-py3-none-any.whl | Python 3 | none | any | Details for lintel_api-0.1.0a6-py3-none-any.whl |
Total release size: 290.5 kB
Release files / lintel_api-0.1.0a6.tar.gz
| Download URL | lintel_api-0.1.0a6.tar.gz |
|---|---|
| Size | 201.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2c0147fa535e6d74f7c494a3c46afac865be4d4b6ac1c8249e75d5303210cc4d
|
|
BLAKE2b-256 checksum How to use checksums |
d7ad953d67eec88156aaa8ed6d26ce9e6c33388cc629232b1793bb5dec41085b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.
Transparency logRelease files / lintel_api-0.1.0a6-py3-none-any.whl
| Download URL | lintel_api-0.1.0a6-py3-none-any.whl |
|---|---|
| Size | 89.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1b87d3f784e772bcec0a0b1efeeb45544f110bcf3617809fce46e66e12fcb0a1
|
|
BLAKE2b-256 checksum How to use checksums |
a46df52cd5375009d6574b1e05231f9339429dad8f55d76fe8eea1ac75085358
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.
Transparency logSecurity for lintel-api 0.1.0a6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for lintel_api-0.1.0a6.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.