Dear Gramps users and developers,
the first version of the Gramps Web API has been released today.
What is it?
It is a new Python package that allows yout to host your family tree database on a web server and access it via a HTTP REST API. Currently, only read access is implemented, but adding write access (to add new or modify existing objects like people, events, media, …) is on the roadmap.
Why is this useful?
The main use case is arguably to serve as a backend for connected apps (web or mobile) as alternative ways to access a Gramps family tree - either to share your work with others, or when you’re on the go without a laptop. I am working on a web frontend called Gramps.js (which I plan to talk about in another post), which is one possible application. But having a standard backend enables the community to build many different tools on the same powerful framework. A discussion that triggered the development of the package can be found here.
What does it look like?
On the Github project page, you can find a link to the API documentation and a demo server.
What is the status of the project?
The first version of the package was released to PyPI today, but most of the work for this release was done a couple of months ago. Read access is already quite complete, while write access has not been implemented yet. So far, only three people have contributed to the code base, so it would be great to have more people contributing.
How can I use it?
Please see the documentation on Github.