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 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.2.tar.gz (71.0 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.2-py3-none-any.whl (96.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: greatgramps-0.2.2.tar.gz
  • Upload date:
  • Size: 71.0 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.2.tar.gz
Algorithm Hash digest
SHA256 a2d844508958d10c762e83077ead793c2a593ae723b6c376881a5ac9a80bbec1
MD5 b6937e4f9cda3a93426f467778be8d81
BLAKE2b-256 f94fa92a604fec16c906cef15228254ed70d950f22e1b09e5f78ca0c1b673d60

See more details on using hashes here.

File details

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

File metadata

  • Download URL: greatgramps-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 96.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 155852180df5a003d2f75714941800320ad37c490c9f264924da90a6bca61d57
MD5 2269548bb6cda3826dd4f62d2336981a
BLAKE2b-256 940449adb6a68b256a4bdc1a2fe9ac41300444d960d64e72926b095c46006327

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