Skip to content

README.md

Latest commit

 

History

History
36 lines (25 loc) · 856 Bytes

README.md

File metadata and controls

36 lines (25 loc) · 856 Bytes
Raw

Maple Data API

Parquet-backed FastAPI service for Maple Atlas.

Development

python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -e ".[dev]"
pytest

The service reads:

  • MAPLE_PARQUET_PATH (default /srv/maple-atlas/data/grants.parquet)
  • MAPLE_MANIFEST_PATH (default /srv/maple-atlas/data/grants.manifest.json)

Run it with:

uvicorn maple_data_api.app:app --host 127.0.0.1 --port 8000

Endpoints:

  • GET /health
  • GET /v1/grants

Grant queries support text, province, department, agreement start-date range, minimum-value, pagination, and sort parameters. Records default to newest agreement start date first, with missing dates last.

See docs/HANDOFF.md for the production architecture, server paths, deployment procedure, dataset refresh process, and troubleshooting guide.