Skip to main content

Family tree static site generator for GRAMPS databases

Project description

greatgramps

A static site generator for GRAMPS family tree databases.

greatgramps reads a GRAMPS database and builds a browsable static website from it. Each person in the tree gets their own page with biographical details, family relationships, events, photos, and a relationship label showing how they connect to a chosen root person. The site also includes index pages for people, places, events, census records, birthdays, and surnames.

The site is built from the point of view of one or more root people — typically the living members of a family who each want to browse the tree as themselves. Each root person gets their own section of the site where relationship labels ("your grandmother", "your 2nd cousin") are calculated relative to them. A top-level index page lets you switch between roots.

The site is generated once and served as plain HTML — no server-side code required. It's not a web frontend for GRAMPS (like gramps-web), in that it's read-only, but it produces a fairly rich browsable site for your tree. Once built, the site can be hosted with ease, with no Python or GRAMPS installation required.

This approach lets you manage your own tree using open source software without relying on subscription or proprietary services, while still making it easy to share your tree with your family on the web.

Demo

A demo is available at gramps.bennuttall.com which features a generated family tree showcasing what greatgramps can build from a GRAMPS database.

Requirements

  • Python 3.10+
  • A GRAMPS sqlite database
  • GRAMPS

Installation

Install GRAMPS first. See the GRAMPS installation instructions.

Also install PyICU for locale-aware sorting, via your platform's package manager (otherwise GRAMPS logs a warning and falls back to less accurate sorting of names and places). On Debian/Ubuntu:

sudo apt install python3-icu

Then install the project. The core package only handles reading the GRAMPS database; pick the extras for the features you need:

pip install greatgramps[cli,html,pdf]
  • cli — the grgr command-line tool
  • html — the grgr build / grgr rebuild-page commands for generating the static site
  • pdf — the grgr pdf commands (also requires Ghostscript)

If you only have the html extra installed (no cli), build the site with python -m greatgramps.build instead of grgr build — it has no dependency on typer or rich.

Links

Licence

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

greatgramps-0.2.1.tar.gz (65.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

greatgramps-0.2.1-py3-none-any.whl (88.0 kB view details)

Uploaded Python 3

File details

Details for the file greatgramps-0.2.1.tar.gz.

File metadata

  • Download URL: greatgramps-0.2.1.tar.gz
  • Upload date:
  • Size: 65.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for greatgramps-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ac25e4ac4c14a3d89fb9fbeb46cd39e860ab659642b01fbf659f181e0a16c99a
MD5 1102e5970d50b5aaeb7f9cb0f181b633
BLAKE2b-256 3b787a5c8dfcc3fc074873da637ebdf5bc30dcb740a6a1cb84948d4511dfc392

See more details on using hashes here.

File details

Details for the file greatgramps-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: greatgramps-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 88.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for greatgramps-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3145a25018d490dda3b4f3d4bb9df7bcc9cf20ac5b72587707784b7ada1c124d
MD5 537f0c7c6d789ff6856ab91b6cf4b53d
BLAKE2b-256 0beb5145b6b25e0205e11c809204535c20c6153b35db7051ffaee7a209c20dda

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page