Repository template

Build a Fairspec extension

A template for rapid Fairspec extension development. Generates Python and TypeScript SDKs automatically from your profile and table schemas.

Everything an extension needs

Sensible defaults, no setup to start, and SDKs you don't have to maintain.

Simple

Publish a Fairspec extension in minutes, without writing any boilerplate. Edit a JSON schema and run one command.

Modern

Built on the latest Fairspec standard, supporting any business domain logic with a clean, well-typed surface.

Standard

Based on the widely-used Fairspec specification, making extensions compatible with the wider Fairspec software ecosystem.

Automatic

Python and TypeScript SDKs are generated from your schemas — no hand-written models, no drift between languages.

Versioned

Semantic versioning, GitHub releases, and an auto-published changelog wired up out of the box.

Documented

Specification and data tables render to a Livemark documentation site that ships with the template.

Define a schema. Ship an SDK.

Author your profile and table schemas; the template generates typed Python and TypeScript bindings, validation, and a docs site.

dataset.json
{
  "$schema": "https://fairspec.github.io/fairspec-extension/profiles/0.4.0/dataset.json",
  "resources": [
    {
      "name": "table1",
      "tableSchema": "https://fairspec.github.io/fairspec-extension/schemas/0.4.0/table1.json",
      "data": [
        {
          "id": "t1-001",
          "name": "First Entity",
          "status": "active",
          "value": 100.5,
          "isVerified": true
        }
      ]
    }
  ]
}

Describe your data. Publish your extension.

Click "Use this template" on GitHub, configure the metadata, edit your schemas, and ship.

Built on open, well-adopted standards

FairspecJSON Schema 2020-12PythonTypeScriptpnpmLivemark