Gramps Web
Productivity & WikisPython REST API that lets you query and manipulate a Gramps genealogy database over the web
Features
- Expose Gramps family‑tree data via HTTP endpoints
- Support querying and modifying the genealogy database
- Serve as backend for Gramps Web or other custom tools
Recent releases
View all 17 releases →
v3.13.0
Breaking risk
⚠ Upgrade required
- Automatic migration runs on startup when using the default docker image and entrypoint; custom deployments must execute the migration command manually before starting the service.
Breaking changes
- Database schema migration required for new OIDC feature; must run `python3 -m gramps_webapi --config /app/config/config.cfg user migrate` in custom environments.
Notable features
- Tree-specific configuration stored in the database.
- Support for nested filter rules matching Gramps core complexity.
- Celery background tasks (imports, search index updates) tracked in the database for progress monitoring.
Full changelog
Configuration for trees
This release adds the possibility to add tree-specific configuration to the database. This will enable features requiring tree owner configuration in Gramps Web (https://github.com/gramps-project/gramps-web-api/pull/833)
Nested filters
Filter rules can now be nested, matching the full complexity of filters that can be defined in Gramps core (https://github.com/gramps-project/gramps-web-api/pull/828)
Track background tasks in database
Celery background tasks like imports or search index updates are now tracked in the database, enabling more consistent and complete progress tracking in Gramps Web (https://github.com/gramps-project/gramps-web-api/pull/827)
Speed up loading of revision history
Loading the revision history was unnecessarily slow on large databases due to suboptimal SQL queries. Fixed in https://github.com/gramps-project/gramps-web-api/pull/836
Other changes
- Fix GEDCOM7 import error handling to use appropriate HTTP status codes (https://github.com/gramps-project/gramps-web-api/pull/832)
- Allow customizing the transaction commit message (https://github.com/gramps-project/gramps-web-api/pull/834)
- Fix alembic duplicate head and detect in CI (https://github.com/gramps-project/gramps-web-api/pull/838)
- Set HuggingFace cache path (https://github.com/gramps-project/gramps-web-api/pull/837)
User database migration ⚠️
Since the new OIDC feature requires a change to the schema of the Gramps Web user database, a schema migration must be run once (regardless of whether you plan to use OIDC or not). When using the default docker image and entrypoint, this is done automatically on startup. In custom environments, you will need to run
python3 -m gramps_webapi --config /app/config/config.cfg user migrate
in the Gramps Web API contrainer, or something equivalent for your custom setup.
The same command can also be used inside the Dev Container by developers using the recommended development environment, after pulling the latest Web API version.
Full Changelog: https://github.com/gramps-project/gramps-web-api/compare/v3.12.2...v3.13.0
Weekly OSS security release digest.
The CVE patches and breaking changes that affected production tools this week. One email, every Sunday.
No spam, unsubscribe anytime.
