Skip to main content

FastAPI REST server + bundled React web UI for Evidentia

Project description

evidentia-api

FastAPI REST server and bundled React web UI for Evidentia, the open-source GRC tool.

This package is not typically installed directly. The preferred way is via the [gui] extra on the meta-package:

uv tool install "evidentia[gui]"
# or
pip install "evidentia[gui]"

Then run:

evidentia serve
# -> FastAPI + React UI at http://127.0.0.1:8000

What's inside

  • FastAPI app (evidentia_api.app:app) — REST endpoints mirroring every CLI capability.
  • SPA — React/Vite/shadcn/ui frontend, bundled as static assets inside the wheel under evidentia_api/static/.
  • SSE streaming — long-running LLM calls (risk generate, explain) stream progress to the browser without blocking.

REST surface

Every endpoint is typed with Pydantic models reused from evidentia-core. All endpoints bind to 127.0.0.1 by default; --host 0.0.0.0 emits a security warning.

Method Path Purpose
GET /api/health Health probe
GET /api/version Evidentia version info
GET /api/doctor Diagnostic summary
POST /api/doctor/check-air-gap Air-gap validator
GET /api/config Read evidentia.yaml
PUT /api/config Write evidentia.yaml
GET /api/frameworks List all 82 bundled catalogs
GET /api/frameworks/{id} Framework detail
GET /api/frameworks/{id}/controls/{control_id} Single control
POST /api/gap/analyze Run GapAnalyzer, save to gap store
GET /api/gap/reports List saved reports
GET /api/gap/reports/{key} Load a saved report
POST /api/gap/diff Compute diff between two reports
POST /api/risk/generate SSE: per-gap risk statement generation
POST /api/explain/{framework}/{control_id} Plain-English control explanation
POST /api/init/wizard Generate starter YAML files
GET /api/llm-status LLM provider configuration state

Air-gapped mode

Running evidentia serve --offline wires the air-gap guard into every /api/* call. LLM features gracefully degrade with a pointer to Ollama. See docs/air-gapped.md.

Development

# From the repo root:
uv sync --all-packages
cd packages/evidentia-ui && npm install && npm run dev  # Vite dev server at :5173
# In another terminal:
evidentia serve --dev  # FastAPI at :8000 proxies /api/* to itself, / to Vite :5173

License

Apache-2.0 — see LICENSE.

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

evidentia_api-0.7.6.tar.gz (452.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

evidentia_api-0.7.6-py3-none-any.whl (462.5 kB view details)

Uploaded Python 3

File details

Details for the file evidentia_api-0.7.6.tar.gz.

File metadata

  • Download URL: evidentia_api-0.7.6.tar.gz
  • Upload date:
  • Size: 452.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for evidentia_api-0.7.6.tar.gz
Algorithm Hash digest
SHA256 acc424ce7229cd56bbe4c1e5849cf0d9b81b6f104051fc198f8547d26419ad38
MD5 9d620257805f40f0d32488e6d80d3631
BLAKE2b-256 6a5f6710a1bc1087d860475688a628b5fba3f772d96e6e42899775fdb195c43a

See more details on using hashes here.

Provenance

The following attestation bundles were made for evidentia_api-0.7.6.tar.gz:

Publisher: release.yml on allenfbyrd/evidentia

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file evidentia_api-0.7.6-py3-none-any.whl.

File metadata

  • Download URL: evidentia_api-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 462.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for evidentia_api-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e60729b33234b39aee4ab758a69a43b162cd5c408da5868c5f457beeb405abe2
MD5 5f82e754373c024f1651ca3b714f4560
BLAKE2b-256 c1106cb75ebd1d76d00d23c70a0df9320bb5cf06d4493ba960add8c7b17b0124

See more details on using hashes here.

Provenance

The following attestation bundles were made for evidentia_api-0.7.6-py3-none-any.whl:

Publisher: release.yml on allenfbyrd/evidentia

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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