gramps-api-client
A minimal, dependency-free Python client for Gramps Web API. Standard library only (urllib, json, base64) — no requests, no gramps package needed.
Install
pip install -e .
(Not yet published to PyPI.)
Credentials
The client is built from a single GRAMPS_WEB_API_KEY-shaped string, <REFRESH_TOKEN>*<BASE64URL(URL)>. Mint one once via username/password, either from the CLI:
gramps-api-client generate-key --url https://your-server/api --username youruser
# prompts for the password (getpass, never a CLI flag), prints the key to stdout
or in Python:
from gramps_api_client import Client
api_key = Client.mint_api_key("https://your-server/api", "username", "password")
# store api_key somewhere safe (env var, secrets manager, ...) -- it is a
# long-lived, non-revocable-except-by-password-change credential, treat it
# like a password.
From then on, either construct directly from that key, or set it as
GRAMPS_WEB_API_KEY in the environment and use Client.from_env():
import os
from gramps_api_client import Client
os.environ["GRAMPS_WEB_API_KEY"] = api_key
client = Client.from_env()
transactions, total = client.get_transaction_history(after=0)
See Client's and push_transaction()'s docstrings in
src/gramps_api_client/client.py
for the full credential-tradeoff writeup and conflict-handling semantics.
Origin
This client began life inside the
GrampsWebSync
addon and the GrampsWebApiDb addon (both gramps-project/addons-source;
GrampsWebApiDb is not yet merged upstream), which each needed a
dependency-free HTTP client to talk to a Gramps Web API server. This
package is now the standalone, canonical home for that code —
GrampsWebApiDb vendors a synced copy of client.py, since Gramps addons
are self-contained tarballs with no mechanism to declare a pip dependency
on an external package.
Development
python3 -m venv .venv
.venv/bin/pip install -e ".[dev]"
.venv/bin/pytest -v
License
GPL-2.0-or-later, matching the addon code this was extracted from. See
LICENSE.
Metadata
Release files for gramps-api-client 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gramps_api_client-1.2.2.tar.gz | 25.6 kB | Without provenance | Details for gramps_api_client-1.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gramps_api_client-1.2.2-py3-none-any.whl | Python 3 | none | any | Details for gramps_api_client-1.2.2-py3-none-any.whl |
Total release size: 45.4 kB
Release files / gramps_api_client-1.2.2.tar.gz
| Download URL | gramps_api_client-1.2.2.tar.gz |
|---|---|
| Size | 25.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
de39bcc0602882dd45edf194412bcba22d6d68300df5f9a9577b66a660e93fe8
|
|
BLAKE2b-256 checksum How to use checksums |
029bd36118b418eaad6cfab1517116794baabb9c95b92492d3fa687ac269a078
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.2
|
Release files / gramps_api_client-1.2.2-py3-none-any.whl
| Download URL | gramps_api_client-1.2.2-py3-none-any.whl |
|---|---|
| Size | 19.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
245f652a351f15aff9a463465bf4f21b8f760913fd9475a93204cca9c2e70d74
|
|
BLAKE2b-256 checksum How to use checksums |
b6686875294e21ebfadcb02ecd270d07b26de70d73261c69ab13b11ec7e7773e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.2
|
Security for gramps-api-client 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.