Gramps Web API

Gramps Web API is a Python-based RESTful backend that exposes Gramps family tree databases over HTTP. It is the server-side component of the Gramps Web project and can be used by the official frontend or as a backend for other genealogy tools.

Key Features

• RESTful endpoints for core Gramps concepts (people, families, events, sources, places, media) with CRUD operations
• Native integration with the Gramps data model and database artifacts
• Support for media objects and associated metadata (photos, documents)
• Authentication and basic permission controls for multi-user deployments
• API documentation and developer-focused interfaces for automation and scripting
• Docker-friendly deployment and templated views for server-side rendering where applicable

Use Cases

• Host a web-accessible family tree service that serves Gramps data to web frontends
• Provide a backend API for third-party genealogy tools, scripts, or mobile apps
• Expose family tree data and media for backups, exports, or automated processing pipelines

Limitations and Considerations

• Backend-only: this repository provides the API layer and is typically paired with a separate frontend; it is not a full web UI by itself
• Relies on the Gramps data model and database files; administrators need familiarity with Gramps formats and configuration
• Scaling and performance for very large trees may require additional tuning or external database/configuration work

Gramps Web API is a focused service for exposing Gramps databases over HTTP, suitable for self-hosted genealogy deployments and integrations. It is developer-oriented and intended to be paired with a frontend or other tooling to provide a complete user experience.