Skip to content

External Integration

JsonIBase deliberately does not implement Git, GitHub, pull requests, branches, commits, cloud sync, or hosted APIs.

External tools can integrate by using:

  • Canonical JSONL source files.
  • ChangeResult.changed_files.
  • SourceManifest fingerprints.
  • JsonIBase.status() for freshness.
  • JsonIBase.validate() for CI checks.

The examples under examples/ show one integration pattern: fetch public internet data, normalize it into Pydantic models, and let JsonIBase own the canonical JSONL and derived search index.

Repository owners decide how to ignore or track .jsonibase/ artifacts. A common ignore policy is:

.jsonibase/*.db
.jsonibase/*.db-wal
.jsonibase/*.db-shm
.jsonibase/locks/
.jsonibase/transactions/

CI pattern

Use the library or CLI in CI to validate source files before publishing or deploying:

uv run jsonibase validate --root . --collection standards --path data/standards.jsonl --fts title --fts body

For Python applications, call store.validate() and fail the job when ValidationReport.ok is false.