Skip to content

Releases

v0.2

Choose a tag to compare

@DavidMStraub DavidMStraub released this 18 Sep 08:57

Added

  • Notes and tags: get_note, iter_notes, create_note, update_note, delete_note and the same methods for tags.
  • delete_* methods for all object types.
  • get_*_by_gramps_id methods for all object types except tags.
  • search(query) for full-text search.
  • timeout and session arguments to API.
  • API can be used as a context manager, and has a close() method.
  • GrampsWebAPIError with status_code and the decoded JSON error body in data.
  • The client sends a User-Agent header.
  • Type hints (py.typed).

Changed

  • Python 3.10 or newer is required.
  • All errors raise GrampsWebAPIError, a subclass of requests.HTTPError. Previously, get_* methods raised a plain Exception when the server returned a JSON error body.
  • Expired access tokens are renewed automatically.
  • Query parameters of iter_* methods are now URL-encoded. Lists are sent comma-separated and dictionaries as JSON.

v0.1

Choose a tag to compare

@DavidMStraub DavidMStraub released this 18 Jan 20:06

The first release.