Skip to content

Editions: community and ee (open core)

ExtractIt is open core (decision of the owner, 2026-11-10; ADR-020):

Community edition Commercial edition (ee)
Code everything outside ee/ and web/src/ee/ ee/ (distribution extractit-ee) and web/src/ee/
License FSL-1.1-ALv2 — source-available (Fair Source), not open source: read, run and modify for any purpose except a Competing Use; each version becomes Apache-2.0 two years after it is made available. The SDKs, schemas/, examples/ and skills/ are Apache-2.0 FSL-1.1-ALv2, same terms
SPDX header SPDX-License-Identifier: FSL-1.1-ALv2 (Apache-2.0 under sdk/, schemas/, examples/, skills/) SPDX-License-Identifier: FSL-1.1-ALv2
Contributions DCO (git commit -s); external contributions will need a CLA before they are accepted CLA required (the DCO does not grant the right to relicense)
Install pip install extractit / uv sync plus uv pip install -e ee/ (not published)
Works alone yes, complete no: it extends the core

The full license map (who is FSL, who is Apache-2.0, and why) is on the License page. The licensor name in LICENSE, ee/LICENSE and web/src/ee/LICENSE is still the placeholder <LICENSOR>, to be filled in by the owner before the first publication. Nothing is published yet: no PyPI, no npm, no registry, no container image.

Features by edition

Feature Community ee Ticket
Library, extractit CLI, parsing, extraction, verification, rules ✓ ✓ F1
Server API, workflows, runs, review, evaluation ✓ ✓ F2–F3
Studio (web), evidence viewer ✓ ✓ T18
Agent mode, plugins and the Code node ✓ ✓ T10, T30
OIDC login, members, roles, API keys, audit log ✓ ✓ T12, T13
Standard deployment (Compose, Helm) ✓ ✓ T53
GET /v1/meta (edition, version, features) ✓ (community) ✓ (ee) T57
Extension example (/v1/ee/example/notes, extractit ee info, settings page) — ✓ T57
Model policies (organization, project, node), BYOK keys, model catalog (/v1/models) ✓ ✓ T49
SSO per organization (OIDC, SAML through a Keycloak broker) and SCIM 2.0 provisioning — ✓ T49
Usage, credits, plans and budgets (billing; see Billing) — ✓ T51
Air-gapped profile — ✓ T54

How the core finds the edition (extension points)

The core never imports extractit_ee (import-linter contract core-does-not-import-ee). Extensions are found through the entry point group extractit.extensions; each entry point names an object with register(registry):

# ee/pyproject.toml
[project.entry-points."extractit.extensions"]
ee = "extractit_ee"
def register(registry: ExtensionRegistry) -> None:
    registry.require_same_minor("extractit-ee", installed_version())
    registry.add_router(lambda: router, tags=[{"name": "ee-example", "description": "..."}])
    registry.add_migrations(MIGRATIONS, "ee", requires_core="0008_t30")
    registry.add_cli("ee", "extractit_ee.example.cli:app")
    registry.add_hook("app.startup", on_startup)
    registry.declare_feature("ee.example")

The registry (extractit.extensions.registry) loads every extension once per process, when the API application is created or when extractit lists its commands, in name order. Any exception in register stops startup with an error that names the extension. The edition is ee when the extension named ee loaded, community otherwise; GET /v1/meta returns it with the core version and the declared features.

Contribution What the core does with it
add_router(router, tags) Included after the core routers (built with dx_router and require, so permissions, audit, rate classes and RFC 9457 errors are the core's). A method + path already served by the core or another extension fails with RouteConflict naming both. Tags are appended to the OpenAPI tags.
add_migrations(path, label, requires_core=...) An Alembic environment of its own (see below).
add_cli(name, app) A extractit sub-command (typer.Typer, a function or "module:attr"), listed by extractit --help only when installed. A name the core uses is rejected.
add_hook(point, fn) A function on a hook point that a core module declared.
declare_feature(name) Listed by GET /v1/meta.

Hook points

An extension can add error codes with extractit.api.errors.register_error (they are not part of the community OpenAPI snapshot). A hook point is a contract of the core. A ticket that needs a new one declares it in its own core module with extractit.extensions.hooks.declare_point(name, description) (an additive change) instead of importing ee.

Point Called Hooks receive
app.startup once, when the API application starts (lifespan) the FastAPI app
runs.admission before a run is created and enqueued: POST /v1/parse, POST /v1/extract, POST /v1/runs, POST /v1/runs/{id}:rerun an AdmissionRequest (tenant, project, kind, principal, details); raising AdmissionDenied(detail, reason=...) rejects the run with RFC 9457 run-not-admitted (403) and nothing is enqueued
runs.created (T51) inside the transaction that inserts a run (RunService.submit and submit_many), after its run.queued event, before it commits and before it is enqueued (session, RunCreated); raising an ApiError (for example 402 budget_exceeded) rolls the transaction back: no run, nothing enqueued
runs.finished (T51) inside the transaction of a run's transition to a terminal status (session, RunFinished)
interpreter.activity_closed (T51) once per activity the interpreter closes (node and scope), inside the transaction that closes its node_run (session, ActivityClosed)

Migrations of an extension

Each extension has its own Alembic environment (plan B of T57): its own linear chain, its own version table alembic_version_<label> and tables prefixed <label>_ (ee_…). Its env.py is one call to extractit.store.migrations.extensions.run_extension_env(metadata, branch_label="ee"); the first revision records the core revision it was written against (requires_core), and upgrading fails with a clear message when the core is older.

  • The core chain stays linear and alembic upgrade head keeps working whatever is installed.
  • python -m extractit.store.admin migrate (or python -m extractit.store.migrations.extensions upgrade) applies the core chain and then every installed extension chain.
  • Tables of an extension follow the tenancy rules (T11): tenant_id, project_id when project-scoped, RLS tenant_isolation through apply_rls(), and a cross-tenant leak test.
  • Uninstalling an extension leaves its tables and version table: the core starts normally and its alembic check/autogenerate ignore alembic_version_* and the reserved prefix ee_.

Why not one Alembic tree with an ee branch label: with two heads every core alembic upgrade head (the tests and tools of every ticket) would need heads, and after uninstalling ee the core would find an unknown revision in its version table. A separate environment avoids both.

Web

web/src/ee/ is loaded only by builds with VITE_DX_EDITION=ee. src/main.tsx imports it with a dynamic import() behind import.meta.env.VITE_DX_EDITION === "ee", and vite.config.ts defines that variable as a literal, so the community build folds the condition to false and emits no ee module. scripts/check-edition.mjs searches the community bundle for the ee canary string and for src/ee entries in the Vite manifest; Playwright checks both builds (pnpm --filter web e2e and pnpm --filter web e2e:ee). ee pages register with registerEePages(registerSettingsPage) and carry the Enterprise label.

pnpm --filter web build                                   # community → web/dist
pnpm --filter web build:ee                                # ee → web/dist-ee
pnpm --filter web check:edition --edition community    # no ee code in web/dist

Checks (CI jobs community and ee)

Check Community ee
Full test suite pytest without extractit-ee uv pip install -e "ee/[stripe]", then pytest tests ee/tests
Licenses by directory scripts/check_spdx.py against the table of scripts/license_map.py: FSL-1.1-ALv2 by default, Apache-2.0 under sdk/, schemas/, examples/, skills/ and docs/examples/; a missing header or the wrong license fails same
Core never imports ee lint-imports (core-does-not-import-ee) same, with ee installed
Dependency licenses make licenses make licenses-ee: the runtime environment plus extractit-ee; GPL/AGPL rejected as in the core
Web community build + canary search ee build + Playwright of the ee settings page
# community
uv sync --locked --all-extras && DX_MODEL=fake uv run pytest
# ee (uv sync removes extractit-ee: reinstall it after a sync; `uv run` keeps it)
uv pip install -e "ee/[stripe]" && DX_MODEL=fake uv run --no-sync pytest tests ee/tests